@matheusbsbs / matheus-bagliano / commits / 2162f9f6f8

doc: enforce dashes in placeholders

The CodingGuidelines documents stipulates that multi-word placeholders are to be separated by dashes, not underscores nor spaces. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Jean-Noël Avila committed Dec 25, 2023 at 21:21 UTC 2162f9f6f86df4f49c3a716b5beb3952104ea8b8
34 files changed +90 -90
Documentation/git-blame.txt
+1 -1
@@ -210,7 +210,7 @@ annotated.
210
211 . Each blame entry always starts with a line of:
212
213 - <40-byte hex sha1> <sourceline> <resultline> <num_lines>
213 + <40-byte-hex-sha1> <sourceline> <resultline> <num-lines>
214 +
215 Line numbers count from 1.
216
Documentation/git-bugreport.txt
+2 -2
@@ -52,7 +52,7 @@ OPTIONS
52 -s <format>::
53 --suffix <format>::
54 Specify an alternate suffix for the bugreport name, to create a file
55 - named 'git-bugreport-<formatted suffix>'. This should take the form of a
55 + named 'git-bugreport-<formatted-suffix>'. This should take the form of a
56 strftime(3) format string; the current local time will be used.
57
58 --no-diagnose::
@@ -60,7 +60,7 @@ OPTIONS
60 Create a zip archive of supplemental information about the user's
61 machine, Git client, and repository state. The archive is written to the
62 same output directory as the bug report and is named
63 - 'git-diagnostics-<formatted suffix>'.
63 + 'git-diagnostics-<formatted-suffix>'.
64 +
65 Without `mode` specified, the diagnostic archive will contain the default set of
66 statistics reported by `git diagnose`. An optional `mode` value may be specified
Documentation/git-commit-graph.txt
+1 -1
@@ -13,7 +13,7 @@ SYNOPSIS
13 'git commit-graph write' [--object-dir <dir>] [--append]
14 [--split[=<strategy>]] [--reachable | --stdin-packs | --stdin-commits]
15 [--changed-paths] [--[no-]max-new-filters <n>] [--[no-]progress]
16 - <split options>
16 + <split-options>
17
18
19 DESCRIPTION
Documentation/git-cvsserver.txt
+2 -2
@@ -197,7 +197,7 @@ allowing access over SSH.
197 5. Clients should now be able to check out the project. Use the CVS 'module'
198 name to indicate what Git 'head' you want to check out. This also sets the
199 name of your newly checked-out directory, unless you tell it otherwise with
200 - `-d <dir_name>`. For example, this checks out 'master' branch to the
200 + `-d <dir-name>`. For example, this checks out 'master' branch to the
201 `project-master` directory:
202 +
203 ------
@@ -224,7 +224,7 @@ the database to work reliably (otherwise you need to make sure
224 that the database is up to date any time 'git-cvsserver' is executed).
225
226 By default it uses SQLite databases in the Git directory, named
227 -`gitcvs.<module_name>.sqlite`. Note that the SQLite backend creates
227 +`gitcvs.<module-name>.sqlite`. Note that the SQLite backend creates
228 temporary files in the same directory as the database file on
229 write so it might not be enough to grant the users using
230 'git-cvsserver' write access to the database file without granting
Documentation/git-daemon.txt
+3 -3
@@ -18,7 +18,7 @@ SYNOPSIS
18 [--allow-override=<service>] [--forbid-override=<service>]
19 [--access-hook=<path>] [--[no-]informative-errors]
20 [--inetd |
21 - [--listen=<host_or_ipaddr>] [--port=<n>]
21 + [--listen=<host-or-ipaddr>] [--port=<n>]
22 [--user=<user> [--group=<group>]]]
23 [--log-destination=(stderr|syslog|none)]
24 [<directory>...]
@@ -86,10 +86,10 @@ OPTIONS
86 Incompatible with --detach, --port, --listen, --user and --group
87 options.
88
89 ---listen=<host_or_ipaddr>::
89 +--listen=<host-or-ipaddr>::
90 Listen on a specific IP address or hostname. IP addresses can
91 be either an IPv4 address or an IPv6 address if supported. If IPv6
92 - is not supported, then --listen=hostname is also not supported and
92 + is not supported, then --listen=<hostname> is also not supported and
93 --listen must be given an IPv4 address.
94 Can be given more than once.
95 Incompatible with `--inetd` option.
Documentation/git-diagnose.txt
+1 -1
@@ -45,7 +45,7 @@ OPTIONS
45 -s <format>::
46 --suffix <format>::
47 Specify an alternate suffix for the diagnostics archive name, to create
48 - a file named 'git-diagnostics-<formatted suffix>'. This should take the
48 + a file named 'git-diagnostics-<formatted-suffix>'. This should take the
49 form of a strftime(3) format string; the current local time will be
50 used.
51
Documentation/git-fast-import.txt
+2 -2
@@ -745,11 +745,11 @@ paths for a commit are encouraged to do so.
745
746 `notemodify`
747 ^^^^^^^^^^^^
748 -Included in a `commit` `<notes_ref>` command to add a new note
748 +Included in a `commit` `<notes-ref>` command to add a new note
749 annotating a `<commit-ish>` or change this annotation contents.
750 Internally it is similar to filemodify 100644 on `<commit-ish>`
751 path (maybe split into subdirectories). It's not advised to
752 -use any other commands to write to the `<notes_ref>` tree except
752 +use any other commands to write to the `<notes-ref>` tree except
753 `filedeleteall` to delete all existing notes in this tree.
754 This command has two different means of specifying the content
755 of the note.
Documentation/git-fetch.txt
+2 -2
@@ -186,8 +186,8 @@ origin:
186 ------------------------------------------------
187 $ git fetch origin --prune --prune-tags
188 $ git fetch origin --prune 'refs/tags/*:refs/tags/*'
189 -$ git fetch <url of origin> --prune --prune-tags
190 -$ git fetch <url of origin> --prune 'refs/tags/*:refs/tags/*'
189 +$ git fetch <url-of-origin> --prune --prune-tags
190 +$ git fetch <url-of-origin> --prune 'refs/tags/*:refs/tags/*'
191 ------------------------------------------------
192
193 OUTPUT
Documentation/git-filter-branch.txt
+3 -3
@@ -14,7 +14,7 @@ SYNOPSIS
14 [--msg-filter <command>] [--commit-filter <command>]
15 [--tag-name-filter <command>] [--prune-empty]
16 [--original <namespace>] [-d <directory>] [-f | --force]
17 - [--state-branch <branch>] [--] [<rev-list options>...]
17 + [--state-branch <branch>] [--] [<rev-list-options>...]
18
19 WARNING
20 -------
@@ -32,7 +32,7 @@ listed there as reasonably possible.
32 DESCRIPTION
33 -----------
34 Lets you rewrite Git revision history by rewriting the branches mentioned
35 -in the <rev-list options>, applying custom filters on each revision.
35 +in the <rev-list-options>, applying custom filters on each revision.
36 Those filters can modify each tree (e.g. removing a file or running
37 a perl rewrite on all files) or information about each commit.
38 Otherwise, all information (including original commit times or merge
@@ -624,7 +624,7 @@ with:
624 real backup; it dereferences tags first.)
625
626 ** Running git-filter-branch with either --tags or --all in your
627 - <rev-list options>. In order to retain annotated tags as
627 + <rev-list-options>. In order to retain annotated tags as
628 annotated, you must use --tag-name-filter (and must not have
629 restored from refs/original/ in a previously botched rewrite).
630
Documentation/git-format-patch.txt
+10 -10
@@ -17,10 +17,10 @@ SYNOPSIS
17 [--signature-file=<file>]
18 [-n | --numbered | -N | --no-numbered]
19 [--start-number <n>] [--numbered-files]
20 - [--in-reply-to=<message id>] [--suffix=.<sfx>]
20 + [--in-reply-to=<message-id>] [--suffix=.<sfx>]
21 [--ignore-if-in-upstream] [--always]
22 [--cover-from-description=<mode>]
23 - [--rfc] [--subject-prefix=<subject prefix>]
23 + [--rfc] [--subject-prefix=<subject-prefix>]
24 [(--reroll-count|-v) <n>]
25 [--to=<email>] [--cc=<email>]
26 [--[no-]cover-letter] [--quiet]
@@ -30,8 +30,8 @@ SYNOPSIS
30 [--range-diff=<previous> [--creation-factor=<percent>]]
31 [--filename-max-length=<n>]
32 [--progress]
33 - [<common diff options>]
34 - [ <since> | <revision range> ]
33 + [<common-diff-options>]
34 + [ <since> | <revision-range> ]
35
36 DESCRIPTION
37 -----------
@@ -64,7 +64,7 @@ There are two ways to specify which commits to operate on.
64 to the tip of the current branch that are not in the history
65 that leads to the <since> to be output.
66
67 -2. Generic <revision range> expression (see "SPECIFYING
67 +2. Generic <revision-range> expression (see "SPECIFYING
68 REVISIONS" section in linkgit:gitrevisions[7]) means the
69 commits in the specified range.
70
@@ -179,9 +179,9 @@ Beware that the default for 'git send-email' is to thread emails
179 itself. If you want `git format-patch` to take care of threading, you
180 will want to ensure that threading is disabled for `git send-email`.
181
182 ---in-reply-to=<message id>::
182 +--in-reply-to=<message-id>::
183 Make the first mail (or all the mails with `--no-thread`) appear as a
184 - reply to the given <message id>, which avoids breaking threads to
184 + reply to the given <message-id>, which avoids breaking threads to
185 provide a new patch series.
186
187 --ignore-if-in-upstream::
@@ -219,9 +219,9 @@ populated with placeholder text.
219 Use the contents of <file> instead of the branch's description
220 for generating the cover letter.
221
222 ---subject-prefix=<subject prefix>::
222 +--subject-prefix=<subject-prefix>::
223 Instead of the standard '[PATCH]' prefix in the subject
224 - line, instead use '[<subject prefix>]'. This can be used
224 + line, instead use '[<subject-prefix>]'. This can be used
225 to name a patch series, and can be combined with the
226 `--numbered` option.
227 +
@@ -403,7 +403,7 @@ you can use `--suffix=-patch` to get `0001-description-of-my-change-patch`.
403 `format.useAutoBase` configuration.
404
405 --root::
406 - Treat the revision argument as a <revision range>, even if it
406 + Treat the revision argument as a <revision-range>, even if it
407 is just a single commit (that would normally be treated as a
408 <since>). Note that root commits included in the specified
409 range are always formatted as creation patches, independently
Documentation/git-mv.txt
+1 -1
@@ -16,7 +16,7 @@ DESCRIPTION
16 Move or rename a file, directory, or symlink.
17
18 git mv [-v] [-f] [-n] [-k] <source> <destination>
19 - git mv [-v] [-f] [-n] [-k] <source> ... <destination directory>
19 + git mv [-v] [-f] [-n] [-k] <source> ... <destination-directory>
20
21 In the first form, it renames <source>, which must exist and be either
22 a file, symlink or directory, to <destination>.
Documentation/git-notes.txt
+1 -1
@@ -56,7 +56,7 @@ SUBCOMMANDS
56 list::
57 List the notes object for a given object. If no object is
58 given, show a list of all note objects and the objects they
59 - annotate (in the format "<note object> <annotated object>").
59 + annotate (in the format "<note-object> <annotated-object>").
60 This is the default subcommand if no subcommand is given.
61
62 add::
Documentation/git-replace.txt
+3 -3
@@ -114,11 +114,11 @@ FORMATS
114 The following formats are available:
115
116 * 'short':
117 - <replaced sha1>
117 + <replaced-sha1>
118 * 'medium':
119 - <replaced sha1> -> <replacement sha1>
119 + <replaced-sha1> -> <replacement-sha1>
120 * 'long':
121 - <replaced sha1> (<replaced type>) -> <replacement sha1> (<replacement type>)
121 + <replaced-sha1> (<replaced-type>) -> <replacement-sha1> (<replacement-type>)
122
123 CREATING REPLACEMENT OBJECTS
124 ----------------------------
Documentation/git-revert.txt
+2 -2
@@ -116,7 +116,7 @@ include::rerere-options.txt[]
116
117 --reference::
118 Instead of starting the body of the log message with "This
119 - reverts <full object name of the commit being reverted>.",
119 + reverts <full-object-name-of-the-commit-being-reverted>.",
120 refer to the commit using "--pretty=reference" format
121 (cf. linkgit:git-log[1]). The `revert.reference`
122 configuration variable can be used to enable this option by
@@ -149,7 +149,7 @@ While git creates a basic commit message automatically, it is
149 _strongly_ recommended to explain why the original commit is being
150 reverted.
151 In addition, repeatedly reverting reverts will result in increasingly
152 -unwieldy subject lines, for example 'Reapply "Reapply "<original subject>""'.
152 +unwieldy subject lines, for example 'Reapply "Reapply "<original-subject>""'.
153 Please consider rewording these to be shorter and more unique.
154
155 CONFIGURATION
Documentation/git-send-email.txt
+1 -1
@@ -10,7 +10,7 @@ SYNOPSIS
10 --------
11 [verse]
12 'git send-email' [<options>] <file|directory>...
13 -'git send-email' [<options>] <format-patch options>
13 +'git send-email' [<options>] <format-patch-options>
14 'git send-email' --dump-aliases
15
16
Documentation/git-status.txt
+2 -2
@@ -309,7 +309,7 @@ Line Notes
309 ------------------------------------------------------------
310 # branch.oid <commit> | (initial) Current commit.
311 # branch.head <branch> | (detached) Current branch.
312 -# branch.upstream <upstream_branch> If upstream is set.
312 +# branch.upstream <upstream-branch> If upstream is set.
313 # branch.ab +<ahead> -<behind> If upstream is set and
314 the commit is present.
315 ------------------------------------------------------------
@@ -502,7 +502,7 @@ results, so it could be faster on subsequent runs.
502 usually worth the additional size.
503
504 * `core.untrackedCache=true` and `core.fsmonitor=true` or
505 - `core.fsmonitor=<hook_command_pathname>` (see
505 + `core.fsmonitor=<hook-command-pathname>` (see
506 linkgit:git-update-index[1]): enable both the untracked cache
507 and FSMonitor features and only search directories that have
508 been modified since the previous `git status` command. This
Documentation/git-submodule.txt
+2 -2
@@ -136,7 +136,7 @@ If you really want to remove a submodule from the repository and commit
136 that use linkgit:git-rm[1] instead. See linkgit:gitsubmodules[7] for removal
137 options.
138
139 -update [--init] [--remote] [-N|--no-fetch] [--[no-]recommend-shallow] [-f|--force] [--checkout|--rebase|--merge] [--reference <repository>] [--depth <depth>] [--recursive] [--jobs <n>] [--[no-]single-branch] [--filter <filter spec>] [--] [<path>...]::
139 +update [--init] [--remote] [-N|--no-fetch] [--[no-]recommend-shallow] [-f|--force] [--checkout|--rebase|--merge] [--reference <repository>] [--depth <depth>] [--recursive] [--jobs <n>] [--[no-]single-branch] [--filter <filter-spec>] [--] [<path>...]::
140 +
141 --
142 Update the registered submodules to match what the superproject
@@ -185,7 +185,7 @@ submodule with the `--init` option.
185 If `--recursive` is specified, this command will recurse into the
186 registered submodules, and update any nested submodules within.
187
188 -If `--filter <filter spec>` is specified, the given partial clone filter will be
188 +If `--filter <filter-spec>` is specified, the given partial clone filter will be
189 applied to the submodule. See linkgit:git-rev-list[1] for details on filter
190 specifications.
191 --
Documentation/git-svn.txt
+9 -9
@@ -37,12 +37,12 @@ COMMANDS
37 argument. Normally this command initializes the current
38 directory.
39
40 --T<trunk_subdir>;;
41 ---trunk=<trunk_subdir>;;
42 --t<tags_subdir>;;
43 ---tags=<tags_subdir>;;
44 --b<branches_subdir>;;
45 ---branches=<branches_subdir>;;
40 +-T<trunk-subdir>;;
41 +--trunk=<trunk-subdir>;;
42 +-t<tags-subdir>;;
43 +--tags=<tags-subdir>;;
44 +-b<branches-subdir>;;
45 +--branches=<branches-subdir>;;
46 -s;;
47 --stdlayout;;
48 These are optional command-line options for init. Each of
@@ -726,9 +726,9 @@ ADVANCED OPTIONS
726 when tracking a single URL. The 'log' and 'dcommit' commands
727 no longer require this switch as an argument.
728
729 --R<remote name>::
730 ---svn-remote <remote name>::
731 - Specify the [svn-remote "<remote name>"] section to use,
729 +-R<remote-name>::
730 +--svn-remote <remote-name>::
731 + Specify the [svn-remote "<remote-name>"] section to use,
732 this allows SVN multiple repositories to be tracked.
733 Default: "svn"
734
Documentation/git-tag.txt
+1 -1
@@ -224,7 +224,7 @@ it in the repository configuration as follows:
224
225 -------------------------------------
226 [user]
227 - signingKey = <gpg-key_id>
227 + signingKey = <gpg-key-id>
228 -------------------------------------
229
230 `pager.tag` is only respected when listing tags, i.e., when `-l` is
Documentation/git.txt
+1 -1
@@ -838,7 +838,7 @@ of the SID and an optional counter (to avoid filename
838 collisions).
839 +
840 In addition, if the variable is set to
841 -`af_unix:[<socket_type>:]<absolute-pathname>`, Git will try
841 +`af_unix:[<socket-type>:]<absolute-pathname>`, Git will try
842 to open the path as a Unix Domain Socket. The socket type
843 can be either `stream` or `dgram`.
844 +
Documentation/gitdiffcore.txt
+4 -4
@@ -245,20 +245,20 @@ diffcore-pickaxe: For Detecting Addition/Deletion of Specified String
245
246 This transformation limits the set of filepairs to those that change
247 specified strings between the preimage and the postimage in a certain
248 -way. -S<block of text> and -G<regular expression> options are used to
248 +way. -S<block-of-text> and -G<regular-expression> options are used to
249 specify different ways these strings are sought.
250
251 -"-S<block of text>" detects filepairs whose preimage and postimage
251 +"-S<block-of-text>" detects filepairs whose preimage and postimage
252 have different number of occurrences of the specified block of text.
253 By definition, it will not detect in-file moves. Also, when a
254 changeset moves a file wholesale without affecting the interesting
255 string, diffcore-rename kicks in as usual, and `-S` omits the filepair
256 (since the number of occurrences of that string didn't change in that
257 rename-detected filepair). When used with `--pickaxe-regex`, treat
258 -the <block of text> as an extended POSIX regular expression to match,
258 +the <block-of-text> as an extended POSIX regular expression to match,
259 instead of a literal string.
260
261 -"-G<regular expression>" (mnemonic: grep) detects filepairs whose
261 +"-G<regular-expression>" (mnemonic: grep) detects filepairs whose
262 textual diff has an added or a deleted line that matches the given
263 regular expression. This means that it will detect in-file (or what
264 rename-detection considers the same file) moves, which is noise. The
Documentation/gitformat-index.txt
+2 -2
@@ -386,8 +386,8 @@ The remaining data of each directory block is grouped by type:
386 long, "REUC" extension that is M-bytes long, followed by "EOIE",
387 then the hash would be:
388
389 - Hash("TREE" + <binary representation of N> +
390 - "REUC" + <binary representation of M>)
389 + Hash("TREE" + <binary-representation-of-N> +
390 + "REUC" + <binary-representation-of-M>)
391
392 == Index Entry Offset Table
393
Documentation/githooks.txt
+4 -4
@@ -243,7 +243,7 @@ named remote is not being used both values will be the same.
243 Information about what is to be pushed is provided on the hook's standard
244 input with lines of the form:
245
246 - <local ref> SP <local object name> SP <remote ref> SP <remote object name> LF
246 + <local-ref> SP <local-object-name> SP <remote-ref> SP <remote-object-name> LF
247
248 For instance, if the command +git push origin master:foreign+ were run the
249 hook would receive a line like the following:
@@ -251,9 +251,9 @@ hook would receive a line like the following:
251 refs/heads/master 67890 refs/heads/foreign 12345
252
253 although the full object name would be supplied. If the foreign ref does not
254 -yet exist the `<remote object name>` will be the all-zeroes object name. If a
255 -ref is to be deleted, the `<local ref>` will be supplied as `(delete)` and the
256 -`<local object name>` will be the all-zeroes object name. If the local commit
254 +yet exist the `<remote-object-name>` will be the all-zeroes object name. If a
255 +ref is to be deleted, the `<local-ref>` will be supplied as `(delete)` and the
256 +`<local-object-name>` will be the all-zeroes object name. If the local commit
257 was specified by something other than a name which could be expanded (such as
258 `HEAD~`, or an object name) it will be supplied as it was originally given.
259
Documentation/gitk.txt
+2 -2
@@ -8,7 +8,7 @@ gitk - The Git repository browser
8 SYNOPSIS
9 --------
10 [verse]
11 -'gitk' [<options>] [<revision range>] [--] [<path>...]
11 +'gitk' [<options>] [<revision-range>] [--] [<path>...]
12
13 DESCRIPTION
14 -----------
@@ -124,7 +124,7 @@ gitk-specific options
124 range to show. The command is expected to print on its
125 standard output a list of additional revisions to be shown,
126 one per line. Use this instead of explicitly specifying a
127 - '<revision range>' if the set of commits to show may vary
127 + '<revision-range>' if the set of commits to show may vary
128 between refreshes.
129
130 --select-commit=<ref>::
Documentation/gitprotocol-capabilities.txt
+1 -1
@@ -378,7 +378,7 @@ fetch-pack may send "filter" commands to request a partial clone
378 or partial fetch and request that the server omit various objects
379 from the packfile.
380
381 -session-id=<session id>
381 +session-id=<session-id>
382 -----------------------
383
384 The server may advertise a session ID that can be used to identify this process
Documentation/gitprotocol-http.txt
+7 -7
@@ -391,14 +391,14 @@ C: Start a queue, `c_pending`, ordered by commit time (popping newest
391
392 C: Send one `$GIT_URL/git-upload-pack` request:
393
394 - C: 0032want <want #1>...............................
395 - C: 0032want <want #2>...............................
394 + C: 0032want <want-#1>...............................
395 + C: 0032want <want-#2>...............................
396 ....
397 - C: 0032have <common #1>.............................
398 - C: 0032have <common #2>.............................
397 + C: 0032have <common-#1>.............................
398 + C: 0032have <common-#2>.............................
399 ....
400 - C: 0032have <have #1>...............................
401 - C: 0032have <have #2>...............................
400 + C: 0032have <have-#1>...............................
401 + C: 0032have <have-#2>...............................
402 ....
403 C: 0000
404
@@ -512,7 +512,7 @@ Within the command portion of the request body clients SHOULD send
512 the id obtained through ref discovery as old_id.
513
514 update_request = command_list
515 - "PACK" <binary data>
515 + "PACK" <binary-data>
516
517 command_list = PKT-LINE(command NUL cap_list LF)
518 *(command_pkt)
Documentation/gitprotocol-v2.txt
+4 -4
@@ -199,7 +199,7 @@ which can be used to limit the refs sent from the server.
199
200 Additional features not supported in the base command will be advertised
201 as the value of the command in the capability advertisement in the form
202 -of a space separated list of features: "<command>=<feature 1> <feature 2>"
202 +of a space separated list of features: "<command>=<feature-1> <feature-2>"
203
204 ls-refs takes in the following arguments:
205
@@ -245,7 +245,7 @@ addition of future extensions.
245
246 Additional features not supported in the base command will be advertised
247 as the value of the command in the capability advertisement in the form
248 -of a space separated list of features: "<command>=<feature 1> <feature 2>"
248 +of a space separated list of features: "<command>=<feature-1> <feature-2>"
249
250 A `fetch` request can take the following arguments:
251
@@ -363,7 +363,7 @@ can be included in the client's request as well as the potential
363 addition of the 'packfile-uris' section in the server's response as
364 explained below.
365
366 - packfile-uris <comma-separated list of protocols>
366 + packfile-uris <comma-separated-list-of-protocols>
367 Indicates to the server that the client is willing to receive
368 URIs of any of the given protocols in place of objects in the
369 sent packfile. Before performing the connectivity check, the
@@ -534,7 +534,7 @@ with objects using hash algorithm X. If not specified, the server is assumed to
534 only handle SHA-1. If the client would like to use a hash algorithm other than
535 SHA-1, it should specify its object-format string.
536
537 -session-id=<session id>
537 +session-id=<session-id>
538 ~~~~~~~~~~~~~~~~~~~~~~~
539
540 The server may advertise a session ID that can be used to identify this process
Documentation/gitsubmodules.txt
+2 -2
@@ -151,7 +151,7 @@ the superproject's `$GIT_DIR/config` file, so the superproject's history
151 is not affected. This can be undone using `git submodule init`.
152
153 * Deleted submodule: A submodule can be deleted by running
154 -`git rm <submodule path> && git commit`. This can be undone
154 +`git rm <submodule-path> && git commit`. This can be undone
155 using `git revert`.
156 +
157 The deletion removes the superproject's tracking data, which are
@@ -229,7 +229,7 @@ Workflow for a third party library
229 git submodule add <URL> <path>
230
231 # Occasionally update the submodule to a new version:
232 - git -C <path> checkout <new version>
232 + git -C <path> checkout <new-version>
233 git add <path>
234 git commit -m "update submodule to new version"
235
Documentation/gitweb.conf.txt
+5 -5
@@ -343,7 +343,7 @@ $home_link_str::
343 Label for the "home link" at the top of all pages, leading to `$home_link`
344 (usually the main gitweb page, which contains the projects list). It is
345 used as the first component of gitweb's "breadcrumb trail":
346 - `<home link> / <project> / <action>`. Can be set at build time using
346 + `<home-link> / <project> / <action>`. Can be set at build time using
347 the `GITWEB_HOME_LINK_STR` variable. By default it is set to "projects",
348 as this link leads to the list of projects. Another popular choice is to
349 set it to the name of site. Note that it is treated as raw HTML so it
@@ -604,9 +604,9 @@ Many gitweb features can be enabled (or disabled) and configured using the
604 Each `%feature` hash element is a hash reference and has the following
605 structure:
606 ----------------------------------------------------------------------
607 -"<feature_name>" => {
608 - "sub" => <feature-sub (subroutine)>,
609 - "override" => <allow-override (boolean)>,
607 +"<feature-name>" => {
608 + "sub" => <feature-sub-(subroutine)>,
609 + "override" => <allow-override-(boolean)>,
610 "default" => [ <options>... ]
611 },
612 ----------------------------------------------------------------------
@@ -614,7 +614,7 @@ Some features cannot be overridden per project. For those
614 features the structure of appropriate `%feature` hash element has a simpler
615 form:
616 ----------------------------------------------------------------------
617 -"<feature_name>" => {
617 +"<feature-name>" => {
618 "override" => 0,
619 "default" => [ <options>... ]
620 },
Documentation/gitweb.txt
+1 -1
@@ -305,7 +305,7 @@ pathnames. In most general form such path_info (component) based gitweb URL
305 looks like this:
306
307 -----------------------------------------------------------------------
308 -.../gitweb.cgi/<repo>/<action>/<revision_from>:/<path_from>..<revision_to>:/<path_to>?<arguments>
308 +.../gitweb.cgi/<repo>/<action>/<revision-from>:/<path-from>..<revision-to>:/<path-to>?<arguments>
309 -----------------------------------------------------------------------
310
311
Documentation/trace2-target-values.txt
+1 -1
@@ -5,7 +5,7 @@
5 * `<absolute-pathname>` - Writes to the file in append mode. If the target
6 already exists and is a directory, the traces will be written to files (one
7 per process) underneath the given directory.
8 -* `af_unix:[<socket_type>:]<absolute-pathname>` - Write to a
8 +* `af_unix:[<socket-type>:]<absolute-pathname>` - Write to a
9 Unix DomainSocket (on platforms that support them). Socket
10 type can be either `stream` or `dgram`; if omitted Git will
11 try both.
Documentation/urls.txt
+4 -4
@@ -73,8 +73,8 @@ use will be rewritten into URLs that work), you can create a
73 configuration section of the form:
74
75 ------------
76 - [url "<actual url base>"]
77 - insteadOf = <other url base>
76 + [url "<actual-url-base>"]
77 + insteadOf = <other-url-base>
78 ------------
79
80 For example, with this:
@@ -92,8 +92,8 @@ If you want to rewrite URLs for push only, you can create a
92 configuration section of the form:
93
94 ------------
95 - [url "<actual url base>"]
96 - pushInsteadOf = <other url base>
95 + [url "<actual-url-base>"]
96 + pushInsteadOf = <other-url-base>
97 ------------
98
99 For example, with this:
Documentation/user-manual.txt
+2 -2
@@ -4100,8 +4100,8 @@ independently of the contents or the type of the object: all objects can
4100 be validated by verifying that (a) their hashes match the content of the
4101 file and (b) the object successfully inflates to a stream of bytes that
4102 forms a sequence of
4103 -`<ascii type without space> + <space> + <ascii decimal size> +
4104 -<byte\0> + <binary object data>`.
4103 +`<ascii-type-without-space> + <space> + <ascii-decimal-size> +
4104 +<byte\0> + <binary-object-data>`.
4105
4106 The structured objects can further have their structure and
4107 connectivity to other objects verified. This is generally done with
builtin/commit-graph.c
+1 -1
@@ -22,7 +22,7 @@
22 N_("git commit-graph write [--object-dir <dir>] [--append]\n" \
23 " [--split[=<strategy>]] [--reachable | --stdin-packs | --stdin-commits]\n" \
24 " [--changed-paths] [--[no-]max-new-filters <n>] [--[no-]progress]\n" \
25 - " <split options>")
25 + " <split-options>")
26
27 static const char * builtin_commit_graph_verify_usage[] = {
28 BUILTIN_COMMIT_GRAPH_VERIFY_USAGE,