From da1026cb2c7875cd29d894cda2525d88308aae1d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= Date: Sat, 23 Dec 2023 18:44:08 +0100 Subject: [PATCH] doc: enforce dashes in placeholders MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- Documentation/git-blame.txt | 2 +- Documentation/git-bugreport.txt | 4 ++-- Documentation/git-commit-graph.txt | 2 +- Documentation/git-cvsserver.txt | 4 ++-- Documentation/git-daemon.txt | 6 +++--- Documentation/git-diagnose.txt | 2 +- Documentation/git-fast-import.txt | 4 ++-- Documentation/git-fetch.txt | 4 ++-- Documentation/git-filter-branch.txt | 6 +++--- Documentation/git-format-patch.txt | 20 ++++++++++---------- Documentation/git-mv.txt | 2 +- Documentation/git-notes.txt | 2 +- Documentation/git-replace.txt | 6 +++--- Documentation/git-revert.txt | 4 ++-- Documentation/git-send-email.txt | 2 +- Documentation/git-status.txt | 4 ++-- Documentation/git-submodule.txt | 4 ++-- Documentation/git-svn.txt | 18 +++++++++--------- Documentation/git-tag.txt | 2 +- Documentation/git.txt | 2 +- Documentation/gitdiffcore.txt | 8 ++++---- Documentation/gitformat-index.txt | 4 ++-- Documentation/githooks.txt | 8 ++++---- Documentation/gitk.txt | 4 ++-- Documentation/gitprotocol-capabilities.txt | 2 +- Documentation/gitprotocol-http.txt | 14 +++++++------- Documentation/gitprotocol-v2.txt | 8 ++++---- Documentation/gitsubmodules.txt | 4 ++-- Documentation/gitweb.conf.txt | 10 +++++----- Documentation/gitweb.txt | 2 +- Documentation/trace2-target-values.txt | 2 +- Documentation/urls.txt | 8 ++++---- Documentation/user-manual.txt | 4 ++-- builtin/commit-graph.c | 2 +- 34 files changed, 90 insertions(+), 90 deletions(-) diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt index 5720d04ffe4e74..b1d7fb539d0216 100644 --- a/Documentation/git-blame.txt +++ b/Documentation/git-blame.txt @@ -210,7 +210,7 @@ annotated. . Each blame entry always starts with a line of: - <40-byte hex sha1> + <40-byte-hex-sha1> + Line numbers count from 1. diff --git a/Documentation/git-bugreport.txt b/Documentation/git-bugreport.txt index 392d9eb6aec6b0..ca626f7fc68611 100644 --- a/Documentation/git-bugreport.txt +++ b/Documentation/git-bugreport.txt @@ -52,7 +52,7 @@ OPTIONS -s :: --suffix :: Specify an alternate suffix for the bugreport name, to create a file - named 'git-bugreport-'. This should take the form of a + named 'git-bugreport-'. This should take the form of a strftime(3) format string; the current local time will be used. --no-diagnose:: @@ -60,7 +60,7 @@ OPTIONS Create a zip archive of supplemental information about the user's machine, Git client, and repository state. The archive is written to the same output directory as the bug report and is named - 'git-diagnostics-'. + 'git-diagnostics-'. + Without `mode` specified, the diagnostic archive will contain the default set of statistics reported by `git diagnose`. An optional `mode` value may be specified diff --git a/Documentation/git-commit-graph.txt b/Documentation/git-commit-graph.txt index c8dbceba014639..903b16830ea225 100644 --- a/Documentation/git-commit-graph.txt +++ b/Documentation/git-commit-graph.txt @@ -13,7 +13,7 @@ SYNOPSIS 'git commit-graph write' [--object-dir ] [--append] [--split[=]] [--reachable | --stdin-packs | --stdin-commits] [--changed-paths] [--[no-]max-new-filters ] [--[no-]progress] - + DESCRIPTION diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt index cf4a5a283ecd68..4c475efeab976a 100644 --- a/Documentation/git-cvsserver.txt +++ b/Documentation/git-cvsserver.txt @@ -197,7 +197,7 @@ allowing access over SSH. 5. Clients should now be able to check out the project. Use the CVS 'module' name to indicate what Git 'head' you want to check out. This also sets the name of your newly checked-out directory, unless you tell it otherwise with - `-d `. For example, this checks out 'master' branch to the + `-d `. For example, this checks out 'master' branch to the `project-master` directory: + ------ @@ -224,7 +224,7 @@ the database to work reliably (otherwise you need to make sure that the database is up to date any time 'git-cvsserver' is executed). By default it uses SQLite databases in the Git directory, named -`gitcvs..sqlite`. Note that the SQLite backend creates +`gitcvs..sqlite`. Note that the SQLite backend creates temporary files in the same directory as the database file on write so it might not be enough to grant the users using 'git-cvsserver' write access to the database file without granting diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt index e064f91c9e3589..6ab792228a1045 100644 --- a/Documentation/git-daemon.txt +++ b/Documentation/git-daemon.txt @@ -18,7 +18,7 @@ SYNOPSIS [--allow-override=] [--forbid-override=] [--access-hook=] [--[no-]informative-errors] [--inetd | - [--listen=] [--port=] + [--listen=] [--port=] [--user= [--group=]]] [--log-destination=(stderr|syslog|none)] [...] @@ -86,10 +86,10 @@ OPTIONS Incompatible with --detach, --port, --listen, --user and --group options. ---listen=:: +--listen=:: Listen on a specific IP address or hostname. IP addresses can be either an IPv4 address or an IPv6 address if supported. If IPv6 - is not supported, then --listen=hostname is also not supported and + is not supported, then --listen= is also not supported and --listen must be given an IPv4 address. Can be given more than once. Incompatible with `--inetd` option. diff --git a/Documentation/git-diagnose.txt b/Documentation/git-diagnose.txt index 3ec8cc7ad72374..0711959e6f6eaa 100644 --- a/Documentation/git-diagnose.txt +++ b/Documentation/git-diagnose.txt @@ -45,7 +45,7 @@ OPTIONS -s :: --suffix :: Specify an alternate suffix for the diagnostics archive name, to create - a file named 'git-diagnostics-'. This should take the + a file named 'git-diagnostics-'. This should take the form of a strftime(3) format string; the current local time will be used. diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt index bd7b1e0a2eaf3e..b2607366b91458 100644 --- a/Documentation/git-fast-import.txt +++ b/Documentation/git-fast-import.txt @@ -745,11 +745,11 @@ paths for a commit are encouraged to do so. `notemodify` ^^^^^^^^^^^^ -Included in a `commit` `` command to add a new note +Included in a `commit` `` command to add a new note annotating a `` or change this annotation contents. Internally it is similar to filemodify 100644 on `` path (maybe split into subdirectories). It's not advised to -use any other commands to write to the `` tree except +use any other commands to write to the `` tree except `filedeleteall` to delete all existing notes in this tree. This command has two different means of specifying the content of the note. diff --git a/Documentation/git-fetch.txt b/Documentation/git-fetch.txt index f123139c581001..50900a50dabce9 100644 --- a/Documentation/git-fetch.txt +++ b/Documentation/git-fetch.txt @@ -186,8 +186,8 @@ origin: ------------------------------------------------ $ git fetch origin --prune --prune-tags $ git fetch origin --prune 'refs/tags/*:refs/tags/*' -$ git fetch --prune --prune-tags -$ git fetch --prune 'refs/tags/*:refs/tags/*' +$ git fetch --prune --prune-tags +$ git fetch --prune 'refs/tags/*:refs/tags/*' ------------------------------------------------ OUTPUT diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt index 62e482a95e23fd..5a4f853785d119 100644 --- a/Documentation/git-filter-branch.txt +++ b/Documentation/git-filter-branch.txt @@ -14,7 +14,7 @@ SYNOPSIS [--msg-filter ] [--commit-filter ] [--tag-name-filter ] [--prune-empty] [--original ] [-d ] [-f | --force] - [--state-branch ] [--] [...] + [--state-branch ] [--] [...] WARNING ------- @@ -32,7 +32,7 @@ listed there as reasonably possible. DESCRIPTION ----------- Lets you rewrite Git revision history by rewriting the branches mentioned -in the , applying custom filters on each revision. +in the , applying custom filters on each revision. Those filters can modify each tree (e.g. removing a file or running a perl rewrite on all files) or information about each commit. Otherwise, all information (including original commit times or merge @@ -624,7 +624,7 @@ with: real backup; it dereferences tags first.) ** Running git-filter-branch with either --tags or --all in your - . In order to retain annotated tags as + . In order to retain annotated tags as annotated, you must use --tag-name-filter (and must not have restored from refs/original/ in a previously botched rewrite). diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index aaafce24be20c5..7eb873b2c75141 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -17,10 +17,10 @@ SYNOPSIS [--signature-file=] [-n | --numbered | -N | --no-numbered] [--start-number ] [--numbered-files] - [--in-reply-to=] [--suffix=.] + [--in-reply-to=] [--suffix=.] [--ignore-if-in-upstream] [--always] [--cover-from-description=] - [--rfc] [--subject-prefix=] + [--rfc] [--subject-prefix=] [(--reroll-count|-v) ] [--to=] [--cc=] [--[no-]cover-letter] [--quiet] @@ -30,8 +30,8 @@ SYNOPSIS [--range-diff= [--creation-factor=]] [--filename-max-length=] [--progress] - [] - [ | ] + [] + [ | ] DESCRIPTION ----------- @@ -64,7 +64,7 @@ There are two ways to specify which commits to operate on. to the tip of the current branch that are not in the history that leads to the to be output. -2. Generic expression (see "SPECIFYING +2. Generic expression (see "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7]) means the commits in the specified range. @@ -179,9 +179,9 @@ Beware that the default for 'git send-email' is to thread emails itself. If you want `git format-patch` to take care of threading, you will want to ensure that threading is disabled for `git send-email`. ---in-reply-to=:: +--in-reply-to=:: Make the first mail (or all the mails with `--no-thread`) appear as a - reply to the given , which avoids breaking threads to + reply to the given , which avoids breaking threads to provide a new patch series. --ignore-if-in-upstream:: @@ -219,9 +219,9 @@ populated with placeholder text. Use the contents of instead of the branch's description for generating the cover letter. ---subject-prefix=:: +--subject-prefix=:: Instead of the standard '[PATCH]' prefix in the subject - line, instead use '[]'. This can be used + line, instead use '[]'. This can be used to name a patch series, and can be combined with the `--numbered` option. + @@ -403,7 +403,7 @@ you can use `--suffix=-patch` to get `0001-description-of-my-change-patch`. `format.useAutoBase` configuration. --root:: - Treat the revision argument as a , even if it + Treat the revision argument as a , even if it is just a single commit (that would normally be treated as a ). Note that root commits included in the specified range are always formatted as creation patches, independently diff --git a/Documentation/git-mv.txt b/Documentation/git-mv.txt index 7f991a3380201f..dc1bf61534106a 100644 --- a/Documentation/git-mv.txt +++ b/Documentation/git-mv.txt @@ -16,7 +16,7 @@ DESCRIPTION Move or rename a file, directory, or symlink. git mv [-v] [-f] [-n] [-k] - git mv [-v] [-f] [-n] [-k] ... + git mv [-v] [-f] [-n] [-k] ... In the first form, it renames , which must exist and be either a file, symlink or directory, to . diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt index f8310e56a85ab0..c9221a68ccedc8 100644 --- a/Documentation/git-notes.txt +++ b/Documentation/git-notes.txt @@ -56,7 +56,7 @@ SUBCOMMANDS list:: List the notes object for a given object. If no object is given, show a list of all note objects and the objects they - annotate (in the format " "). + annotate (in the format " "). This is the default subcommand if no subcommand is given. add:: diff --git a/Documentation/git-replace.txt b/Documentation/git-replace.txt index 4f257126e33cc7..0a65460adbded5 100644 --- a/Documentation/git-replace.txt +++ b/Documentation/git-replace.txt @@ -114,11 +114,11 @@ FORMATS The following formats are available: * 'short': - + * 'medium': - -> + -> * 'long': - () -> () + () -> () CREATING REPLACEMENT OBJECTS ---------------------------- diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt index cbe0208834d51f..568925db533879 100644 --- a/Documentation/git-revert.txt +++ b/Documentation/git-revert.txt @@ -116,7 +116,7 @@ include::rerere-options.txt[] --reference:: Instead of starting the body of the log message with "This - reverts .", + reverts .", refer to the commit using "--pretty=reference" format (cf. linkgit:git-log[1]). The `revert.reference` configuration variable can be used to enable this option by @@ -149,7 +149,7 @@ While git creates a basic commit message automatically, it is _strongly_ recommended to explain why the original commit is being reverted. In addition, repeatedly reverting reverts will result in increasingly -unwieldy subject lines, for example 'Reapply "Reapply """'. +unwieldy subject lines, for example 'Reapply "Reapply """'. Please consider rewording these to be shorter and more unique. CONFIGURATION diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt index 465011bad5021a..c1b39acaab47f1 100644 --- a/Documentation/git-send-email.txt +++ b/Documentation/git-send-email.txt @@ -10,7 +10,7 @@ SYNOPSIS -------- [verse] 'git send-email' [] ... -'git send-email' [] +'git send-email' [] 'git send-email' --dump-aliases diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index 10fecc51a75d47..4dbb88373bcdda 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -309,7 +309,7 @@ Line Notes ------------------------------------------------------------ # branch.oid | (initial) Current commit. # branch.head | (detached) Current branch. -# branch.upstream If upstream is set. +# branch.upstream If upstream is set. # branch.ab + - If upstream is set and the commit is present. ------------------------------------------------------------ @@ -502,7 +502,7 @@ results, so it could be faster on subsequent runs. usually worth the additional size. * `core.untrackedCache=true` and `core.fsmonitor=true` or - `core.fsmonitor=` (see + `core.fsmonitor=` (see linkgit:git-update-index[1]): enable both the untracked cache and FSMonitor features and only search directories that have been modified since the previous `git status` command. This diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt index 695730609aa3ab..ca0347a37b554d 100644 --- a/Documentation/git-submodule.txt +++ b/Documentation/git-submodule.txt @@ -136,7 +136,7 @@ If you really want to remove a submodule from the repository and commit that use linkgit:git-rm[1] instead. See linkgit:gitsubmodules[7] for removal options. -update [--init] [--remote] [-N|--no-fetch] [--[no-]recommend-shallow] [-f|--force] [--checkout|--rebase|--merge] [--reference ] [--depth ] [--recursive] [--jobs ] [--[no-]single-branch] [--filter ] [--] [...]:: +update [--init] [--remote] [-N|--no-fetch] [--[no-]recommend-shallow] [-f|--force] [--checkout|--rebase|--merge] [--reference ] [--depth ] [--recursive] [--jobs ] [--[no-]single-branch] [--filter ] [--] [...]:: + -- Update the registered submodules to match what the superproject @@ -185,7 +185,7 @@ submodule with the `--init` option. If `--recursive` is specified, this command will recurse into the registered submodules, and update any nested submodules within. -If `--filter ` is specified, the given partial clone filter will be +If `--filter ` is specified, the given partial clone filter will be applied to the submodule. See linkgit:git-rev-list[1] for details on filter specifications. -- diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt index 4e92308e85db5a..43c68c2ec44f6a 100644 --- a/Documentation/git-svn.txt +++ b/Documentation/git-svn.txt @@ -37,12 +37,12 @@ COMMANDS argument. Normally this command initializes the current directory. --T;; ---trunk=;; --t;; ---tags=;; --b;; ---branches=;; +-T;; +--trunk=;; +-t;; +--tags=;; +-b;; +--branches=;; -s;; --stdlayout;; These are optional command-line options for init. Each of @@ -726,9 +726,9 @@ ADVANCED OPTIONS when tracking a single URL. The 'log' and 'dcommit' commands no longer require this switch as an argument. --R:: ---svn-remote :: - Specify the [svn-remote ""] section to use, +-R:: +--svn-remote :: + Specify the [svn-remote ""] section to use, this allows SVN multiple repositories to be tracked. Default: "svn" diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index d42efb3112787f..5fe519c31ec478 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -224,7 +224,7 @@ it in the repository configuration as follows: ------------------------------------- [user] - signingKey = + signingKey = ------------------------------------- `pager.tag` is only respected when listing tags, i.e., when `-l` is diff --git a/Documentation/git.txt b/Documentation/git.txt index 2535a30194f978..d51473a32741c8 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -838,7 +838,7 @@ of the SID and an optional counter (to avoid filename collisions). + In addition, if the variable is set to -`af_unix:[:]`, Git will try +`af_unix:[:]`, Git will try to open the path as a Unix Domain Socket. The socket type can be either `stream` or `dgram`. + diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt index 3cda2e07c24a96..642c51227b5a0b 100644 --- a/Documentation/gitdiffcore.txt +++ b/Documentation/gitdiffcore.txt @@ -245,20 +245,20 @@ diffcore-pickaxe: For Detecting Addition/Deletion of Specified String This transformation limits the set of filepairs to those that change specified strings between the preimage and the postimage in a certain -way. -S and -G options are used to +way. -S and -G options are used to specify different ways these strings are sought. -"-S" detects filepairs whose preimage and postimage +"-S" detects filepairs whose preimage and postimage have different number of occurrences of the specified block of text. By definition, it will not detect in-file moves. Also, when a changeset moves a file wholesale without affecting the interesting string, diffcore-rename kicks in as usual, and `-S` omits the filepair (since the number of occurrences of that string didn't change in that rename-detected filepair). When used with `--pickaxe-regex`, treat -the as an extended POSIX regular expression to match, +the as an extended POSIX regular expression to match, instead of a literal string. -"-G" (mnemonic: grep) detects filepairs whose +"-G" (mnemonic: grep) detects filepairs whose textual diff has an added or a deleted line that matches the given regular expression. This means that it will detect in-file (or what rename-detection considers the same file) moves, which is noise. The diff --git a/Documentation/gitformat-index.txt b/Documentation/gitformat-index.txt index 0773e5c3800392..145cace1fe9fd3 100644 --- a/Documentation/gitformat-index.txt +++ b/Documentation/gitformat-index.txt @@ -386,8 +386,8 @@ The remaining data of each directory block is grouped by type: long, "REUC" extension that is M-bytes long, followed by "EOIE", then the hash would be: - Hash("TREE" + + - "REUC" + ) + Hash("TREE" + + + "REUC" + ) == Index Entry Offset Table diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt index 883982e7a05162..37f91d5b50ca3a 100644 --- a/Documentation/githooks.txt +++ b/Documentation/githooks.txt @@ -243,7 +243,7 @@ named remote is not being used both values will be the same. Information about what is to be pushed is provided on the hook's standard input with lines of the form: - SP SP SP LF + SP SP SP LF For instance, if the command +git push origin master:foreign+ were run the hook would receive a line like the following: @@ -251,9 +251,9 @@ hook would receive a line like the following: refs/heads/master 67890 refs/heads/foreign 12345 although the full object name would be supplied. If the foreign ref does not -yet exist the `` will be the all-zeroes object name. If a -ref is to be deleted, the `` will be supplied as `(delete)` and the -`` will be the all-zeroes object name. If the local commit +yet exist the `` will be the all-zeroes object name. If a +ref is to be deleted, the `` will be supplied as `(delete)` and the +`` will be the all-zeroes object name. If the local commit was specified by something other than a name which could be expanded (such as `HEAD~`, or an object name) it will be supplied as it was originally given. diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index c2213bb77b380a..35b39960296b69 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -8,7 +8,7 @@ gitk - The Git repository browser SYNOPSIS -------- [verse] -'gitk' [] [] [--] [...] +'gitk' [] [] [--] [...] DESCRIPTION ----------- @@ -124,7 +124,7 @@ gitk-specific options range to show. The command is expected to print on its standard output a list of additional revisions to be shown, one per line. Use this instead of explicitly specifying a - '' if the set of commits to show may vary + '' if the set of commits to show may vary between refreshes. --select-commit=:: diff --git a/Documentation/gitprotocol-capabilities.txt b/Documentation/gitprotocol-capabilities.txt index d6c6effc2151ff..2cf7735be479e6 100644 --- a/Documentation/gitprotocol-capabilities.txt +++ b/Documentation/gitprotocol-capabilities.txt @@ -378,7 +378,7 @@ fetch-pack may send "filter" commands to request a partial clone or partial fetch and request that the server omit various objects from the packfile. -session-id= +session-id= ----------------------- The server may advertise a session ID that can be used to identify this process diff --git a/Documentation/gitprotocol-http.txt b/Documentation/gitprotocol-http.txt index 21b73b7a1f5bd0..d834c745f71929 100644 --- a/Documentation/gitprotocol-http.txt +++ b/Documentation/gitprotocol-http.txt @@ -391,14 +391,14 @@ C: Start a queue, `c_pending`, ordered by commit time (popping newest C: Send one `$GIT_URL/git-upload-pack` request: - C: 0032want ............................... - C: 0032want ............................... + C: 0032want ............................... + C: 0032want ............................... .... - C: 0032have ............................. - C: 0032have ............................. + C: 0032have ............................. + C: 0032have ............................. .... - C: 0032have ............................... - C: 0032have ............................... + C: 0032have ............................... + C: 0032have ............................... .... C: 0000 @@ -512,7 +512,7 @@ Within the command portion of the request body clients SHOULD send the id obtained through ref discovery as old_id. update_request = command_list - "PACK" + "PACK" command_list = PKT-LINE(command NUL cap_list LF) *(command_pkt) diff --git a/Documentation/gitprotocol-v2.txt b/Documentation/gitprotocol-v2.txt index 8c1e7c61eac751..0b800abd567a49 100644 --- a/Documentation/gitprotocol-v2.txt +++ b/Documentation/gitprotocol-v2.txt @@ -199,7 +199,7 @@ which can be used to limit the refs sent from the server. Additional features not supported in the base command will be advertised as the value of the command in the capability advertisement in the form -of a space separated list of features: "= " +of a space separated list of features: "= " ls-refs takes in the following arguments: @@ -245,7 +245,7 @@ addition of future extensions. Additional features not supported in the base command will be advertised as the value of the command in the capability advertisement in the form -of a space separated list of features: "= " +of a space separated list of features: "= " A `fetch` request can take the following arguments: @@ -363,7 +363,7 @@ can be included in the client's request as well as the potential addition of the 'packfile-uris' section in the server's response as explained below. - packfile-uris + packfile-uris Indicates to the server that the client is willing to receive URIs of any of the given protocols in place of objects in the 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 only handle SHA-1. If the client would like to use a hash algorithm other than SHA-1, it should specify its object-format string. -session-id= +session-id= ~~~~~~~~~~~~~~~~~~~~~~~ The server may advertise a session ID that can be used to identify this process diff --git a/Documentation/gitsubmodules.txt b/Documentation/gitsubmodules.txt index 8400d591da0e8a..f7b5a25a0caa91 100644 --- a/Documentation/gitsubmodules.txt +++ b/Documentation/gitsubmodules.txt @@ -151,7 +151,7 @@ the superproject's `$GIT_DIR/config` file, so the superproject's history is not affected. This can be undone using `git submodule init`. * Deleted submodule: A submodule can be deleted by running -`git rm && git commit`. This can be undone +`git rm && git commit`. This can be undone using `git revert`. + The deletion removes the superproject's tracking data, which are @@ -229,7 +229,7 @@ Workflow for a third party library git submodule add # Occasionally update the submodule to a new version: - git -C checkout + git -C checkout git add git commit -m "update submodule to new version" diff --git a/Documentation/gitweb.conf.txt b/Documentation/gitweb.conf.txt index b078fef6f5c6ff..39c959cbe7df3c 100644 --- a/Documentation/gitweb.conf.txt +++ b/Documentation/gitweb.conf.txt @@ -343,7 +343,7 @@ $home_link_str:: Label for the "home link" at the top of all pages, leading to `$home_link` (usually the main gitweb page, which contains the projects list). It is used as the first component of gitweb's "breadcrumb trail": - ` / / `. Can be set at build time using + ` / / `. Can be set at build time using the `GITWEB_HOME_LINK_STR` variable. By default it is set to "projects", as this link leads to the list of projects. Another popular choice is to 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 Each `%feature` hash element is a hash reference and has the following structure: ---------------------------------------------------------------------- -"" => { - "sub" => , - "override" => , +"" => { + "sub" => , + "override" => , "default" => [ ... ] }, ---------------------------------------------------------------------- @@ -614,7 +614,7 @@ Some features cannot be overridden per project. For those features the structure of appropriate `%feature` hash element has a simpler form: ---------------------------------------------------------------------- -"" => { +"" => { "override" => 0, "default" => [ ... ] }, diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt index 1030e9667ea8c2..7b2f2ea6fc14b1 100644 --- a/Documentation/gitweb.txt +++ b/Documentation/gitweb.txt @@ -305,7 +305,7 @@ pathnames. In most general form such path_info (component) based gitweb URL looks like this: ----------------------------------------------------------------------- -.../gitweb.cgi///:/..:/? +.../gitweb.cgi///:/..:/? ----------------------------------------------------------------------- diff --git a/Documentation/trace2-target-values.txt b/Documentation/trace2-target-values.txt index 3985b6d3c2956f..06f19533134f9d 100644 --- a/Documentation/trace2-target-values.txt +++ b/Documentation/trace2-target-values.txt @@ -5,7 +5,7 @@ * `` - Writes to the file in append mode. If the target already exists and is a directory, the traces will be written to files (one per process) underneath the given directory. -* `af_unix:[:]` - Write to a +* `af_unix:[:]` - Write to a Unix DomainSocket (on platforms that support them). Socket type can be either `stream` or `dgram`; if omitted Git will try both. diff --git a/Documentation/urls.txt b/Documentation/urls.txt index 4e79c1589ece05..ce671f812d4ce3 100644 --- a/Documentation/urls.txt +++ b/Documentation/urls.txt @@ -73,8 +73,8 @@ use will be rewritten into URLs that work), you can create a configuration section of the form: ------------ - [url ""] - insteadOf = + [url ""] + insteadOf = ------------ For example, with this: @@ -92,8 +92,8 @@ If you want to rewrite URLs for push only, you can create a configuration section of the form: ------------ - [url ""] - pushInsteadOf = + [url ""] + pushInsteadOf = ------------ For example, with this: diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index d8dbe6b56d42a6..163e8fe77aaca4 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -4100,8 +4100,8 @@ independently of the contents or the type of the object: all objects can be validated by verifying that (a) their hashes match the content of the file and (b) the object successfully inflates to a stream of bytes that forms a sequence of -` + + + - + `. +` + + + + + `. The structured objects can further have their structure and connectivity to other objects verified. This is generally done with diff --git a/builtin/commit-graph.c b/builtin/commit-graph.c index 45d035af6007a2..597927bc56e79a 100644 --- a/builtin/commit-graph.c +++ b/builtin/commit-graph.c @@ -22,7 +22,7 @@ N_("git commit-graph write [--object-dir ] [--append]\n" \ " [--split[=]] [--reachable | --stdin-packs | --stdin-commits]\n" \ " [--changed-paths] [--[no-]max-new-filters ] [--[no-]progress]\n" \ - " ") + " ") static const char * builtin_commit_graph_verify_usage[] = { BUILTIN_COMMIT_GRAPH_VERIFY_USAGE,