Skip to content

Commit 0caea62

Browse files
committed
Merge branch 'fe/doc-updates' into maint
Doc updates. * fe/doc-updates: git-describe.1: clarify that "human readable" is also git-readable git-column.1: clarify initial description, provide examples git-archimport.1: specify what kind of Arch we're talking about
2 parents 2a98f6c + 55f6bce commit 0caea62

File tree

3 files changed

+39
-5
lines changed

3 files changed

+39
-5
lines changed

Documentation/git-archimport.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ git-archimport(1)
33

44
NAME
55
----
6-
git-archimport - Import an Arch repository into Git
6+
git-archimport - Import a GNU Arch repository into Git
77

88

99
SYNOPSIS
@@ -14,7 +14,8 @@ SYNOPSIS
1414

1515
DESCRIPTION
1616
-----------
17-
Imports a project from one or more Arch repositories. It will follow branches
17+
Imports a project from one or more GNU Arch repositories.
18+
It will follow branches
1819
and repositories within the namespaces defined by the <archive/branch>
1920
parameters supplied. If it cannot find the remote branch a merge comes from
2021
it will just import it as a regular commit. If it can find it, it will mark it

Documentation/git-column.txt

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@ SYNOPSIS
1313

1414
DESCRIPTION
1515
-----------
16-
This command formats its input into multiple columns.
16+
This command formats the lines of its standard input into a table with
17+
multiple columns. Each input line occupies one cell of the table. It
18+
is used internally by other git commands to format output into
19+
columns.
1720

1821
OPTIONS
1922
-------
@@ -23,7 +26,7 @@ OPTIONS
2326

2427
--mode=<mode>::
2528
Specify layout mode. See configuration variable column.ui for option
26-
syntax.
29+
syntax in linkgit:git-config[1].
2730

2831
--raw-mode=<n>::
2932
Same as --mode but take mode encoded as a number. This is mainly used
@@ -43,6 +46,34 @@ OPTIONS
4346
--padding=<N>::
4447
The number of spaces between columns. One space by default.
4548

49+
EXAMPLES
50+
------
51+
52+
Format data by columns:
53+
------------
54+
$ seq 1 24 | git column --mode=column --padding=5
55+
1 4 7 10 13 16 19 22
56+
2 5 8 11 14 17 20 23
57+
3 6 9 12 15 18 21 24
58+
------------
59+
60+
Format data by rows:
61+
------------
62+
$ seq 1 21 | git column --mode=row --padding=5
63+
1 2 3 4 5 6 7
64+
8 9 10 11 12 13 14
65+
15 16 17 18 19 20 21
66+
------------
67+
68+
List some tags in a table with unequal column widths:
69+
------------
70+
$ git tag --list 'v2.4.*' --column=row,dense
71+
v2.4.0 v2.4.0-rc0 v2.4.0-rc1 v2.4.0-rc2 v2.4.0-rc3
72+
v2.4.1 v2.4.10 v2.4.11 v2.4.12 v2.4.2
73+
v2.4.3 v2.4.4 v2.4.5 v2.4.6 v2.4.7
74+
v2.4.8 v2.4.9
75+
------------
76+
4677
GIT
4778
---
4879
Part of the linkgit:git[1] suite

Documentation/git-describe.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ The command finds the most recent tag that is reachable from a
1818
commit. If the tag points to the commit, then only the tag is
1919
shown. Otherwise, it suffixes the tag name with the number of
2020
additional commits on top of the tagged object and the
21-
abbreviated object name of the most recent commit.
21+
abbreviated object name of the most recent commit. The result
22+
is a "human-readable" object name which can also be used to
23+
identify the commit to other git commands.
2224

2325
By default (without --all or --tags) `git describe` only shows
2426
annotated tags. For more information about creating annotated tags

0 commit comments

Comments
 (0)