Various unrelated documentation fixes
cover Various unrelated documentation fixes
Here come 4 fixes to the documentation for issues which I spotted when skimming the doc for something else. They are not interrelated (and therefore described there, not here ;) ).
Michael J Gruber (4):
Documentation/git-reflog: Fix formatting of command lists Documentation/gitdiffcore: Remove misleading date in heading Documentation/urls: Remove spurious example markers Documentation/git-clone: Transform description list into item list
Documentation/git-clone.txt | 10 +++++----- Documentation/git-reflog.txt | 2 -- Documentation/gitdiffcore.txt | 2 +- Documentation/urls.txt | 6 ------ 4 files changed, 6 insertions(+), 14 deletions(-)
PATCH 1/4 Documentation/git-reflog: Fix formatting of command lists
A misplaced list continuation mark appears literally in the rendered doc. Fix this by removing it.
--- Documentation/git-reflog.txt | 2 -- 1 files changed, 0 insertions(+), 2 deletions(-)
Documentation/git-reflog.txt +0 -2
@@ -18,9 +18,7 @@ depending on the subcommand: [verse] 'git reflog expire' [--dry-run] [--stale-fix] [--verbose] [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>... -+ 'git reflog delete' ref@\{specifier\}... -+ 'git reflog' ['show'] [log-options] [<ref>] Reflog is a mechanism to record when the tip of branches are
Signature · 1 line
1.7.0.2.358.g30511
PATCH 2/4 Documentation/gitdiffcore: Remove misleading date in heading
In reply to Michael J GruberEver since the automatic conversion into man form, the heading contained a misidentified subheading reading "June 2005". Remove this since the documentation is more recent, and the correct date is in the footer.
--- Documentation/gitdiffcore.txt | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)
Documentation/gitdiffcore.txt +1 -1
@@ -3,7 +3,7 @@ gitdiffcore(7) NAME ---- -gitdiffcore - Tweaking diff output (June 2005) +gitdiffcore - Tweaking diff output SYNOPSIS --------
Signature · 1 line
1.7.0.2.358.g30511
PATCH 3/4 Documentation/urls: Remove spurious example markers
In reply to Michael J GruberIn urls.txt (which is included from git-{clone,fetch,push}.txt) several item lists are surrounded by example block markers. This is problematic for two reasons:
- None of these lists are example lists, so they should not be marked as such semantically.
- The html output looks weird (bulleted list with left sidebar).
Therefore, remove the example block markers. Output by the man backend is uneffected.
--- Documentation/urls.txt | 6 ------ 1 files changed, 0 insertions(+), 6 deletions(-)
Documentation/urls.txt +0 -6
@@ -4,7 +4,6 @@ GIT URLS[[URLS]] One of the following notations can be used to name the remote repository: -=============================================================== - rsync://host.xz/path/to/repo.git/ - http://host.xz{startsb}:port{endsb}/path/to/repo.git/ - https://host.xz{startsb}:port{endsb}/path/to/repo.git/
@@ -14,7 +13,6 @@ to name the remote repository: - ssh://{startsb}user@{endsb}host.xz/path/to/repo.git/ - ssh://{startsb}user@{endsb}host.xz/~user/path/to/repo.git/ - ssh://{startsb}user@{endsb}host.xz/~/path/to/repo.git -=============================================================== SSH is the default transport protocol over the network. You can optionally specify which user to log-in as, and an alternate,
@@ -23,18 +21,14 @@ username expansion, as does the native git protocol, but only the former supports port specification. The following three are identical to the last three above, respectively: -=============================================================== - {startsb}user@{endsb}host.xz:/path/to/repo.git/ - {startsb}user@{endsb}host.xz:~user/path/to/repo.git/ - {startsb}user@{endsb}host.xz:path/to/repo.git -=============================================================== To sync with a local directory, you can use: -=============================================================== - /path/to/repo.git/ - file:///path/to/repo.git/ -=============================================================== ifndef::git-clone[] They are mostly equivalent, except when cloning. See
Signature · 1 line
1.7.0.2.358.g30511
PATCH 4/4 Documentation/git-clone: Transform description list into item list
In reply to Michael J Gruberso that the list of examples is formatted in the same way as for git-fetch, and, more importantly, the different identation for the code blocks in the examples (compared to the immediately preceding code blocks from url.txt) doesn't look like misformatted, but is clarified by the items' bullets.
--- Documentation/git-clone.txt | 10 +++++----- 1 files changed, 5 insertions(+), 5 deletions(-)
Documentation/git-clone.txt +5 -5
@@ -187,7 +187,7 @@ include::urls.txt[] Examples -------- -Clone from upstream:: +* Clone from upstream: + ------------ $ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
@@ -196,7 +196,7 @@ $ make ------------ -Make a local clone that borrows from the current directory, without checking things out:: +* Make a local clone that borrows from the current directory, without checking things out: + ------------ $ git clone -l -s -n . ../copy
@@ -205,7 +205,7 @@ $ git show-branch ------------ -Clone from upstream while borrowing from an existing local directory:: +* Clone from upstream while borrowing from an existing local directory: + ------------ $ git clone --reference my2.6 \
@@ -215,14 +215,14 @@ $ cd my2.7 ------------ -Create a bare repository to publish your changes to the public:: +* Create a bare repository to publish your changes to the public: + ------------ $ git clone --bare -l /home/proj/.git /pub/scm/proj.git ------------ -Create a repository on the kernel.org machine that borrows from Linus:: +* Create a repository on the kernel.org machine that borrows from Linus: + ------------ $ git clone --bare -l -s /pub/scm/.../torvalds/linux-2.6.git \
Signature · 1 line
1.7.0.2.358.g30511