Skip to content

Commit 6fd503a

Browse files
author
Daniel Holbach
committed
reflow commit customization bits, fix link
1 parent 430814d commit 6fd503a

File tree

1 file changed

+23
-21
lines changed

1 file changed

+23
-21
lines changed

docs/references/fluxctl.md

+23-21
Original file line numberDiff line numberDiff line change
@@ -557,54 +557,56 @@ retrieves from the registry.
557557
--user string override the user reported as initiating the update
558558
```
559559

560-
Commit customization
560+
### Commit customization
561561

562-
```text
563562
1. Commit message
564563

565-
fluxctl --message="Message providing more context for the action" .....
564+
```console
565+
fluxctl --message="Message providing more context for the action" .....
566+
```
566567

567-
2. Committer
568+
1. Committer
568569

569570
Committer information can be overriden with the appropriate fluxd flags:
570571

572+
```console
571573
--git-user
572574
--git-email
575+
```
573576

574-
See [docs/features/daemon.md] for more information.
577+
See [daemon.md](daemon.md) for more information.
575578

576-
3. Commit author
579+
1. Commit author
577580

578581
The default for the author is the committer information, which can be overriden,
579582
in the following manner:
580583

581-
a) Default override uses user's git configuration, ie user.name
582-
and user.email (.gitconfig) to set the commit author.
584+
a) Default override uses user's git configuration, ie `user.name`
585+
and `user.email` (.gitconfig) to set the commit author.
583586
If the user has neither user.name nor for
584587
user.email set up, the committer information will be used. If only one
585588
is set up, that will be used.
586589

587-
b) This can be further overriden by the use of the fluxctl --user flag.
590+
b) This can be further overriden by the use of the `fluxctl --user` flag.
588591

589-
Examples
592+
#### Examples
590593

591-
a) fluxctl --user="Jane Doe <jane@doe.com>" ......
592-
This will always succeed as git expects a new author in the format
593-
"some_string <some_other_string>".
594+
1. `fluxctl --user="Jane Doe <jane@doe.com>" ......`
595+
This will always succeed as git expects a new author in the format
596+
"some_string <some_other_string>".
594597

595-
b) fluxctl --user="Jane Doe" .......
596-
This form will succeed if there is already a repo commit, done by
597-
Jane Doe.
598+
1. `fluxctl --user="Jane Doe" .......`
599+
This form will succeed if there is already a repo commit, done by
600+
Jane Doe.
598601

599-
c) fluxctl --user="jane@doe.com" .......
600-
This form will succeed if there is already a repo commit, done by
601-
jane@doe.com.
602-
```
602+
1. `fluxctl --user="jane@doe.com" .......`
603+
This form will succeed if there is already a repo commit, done by
604+
jane@doe.com.
603605

604606
### Errors due to author customization
605607

606608
In case of no prior commit by the specified author, an error will be reported
607-
for b) and c):
609+
for 2) and 3):
608610

609611
```sh
610612
git commit: fatal: --author 'unknown' is not 'Name <email>' and matches

0 commit comments

Comments
 (0)