threads / patch / 2515

patch, 3 partsDocumentation additions and fixes

Subject: [PATCH 0/3] Documentation additions and fixes

## tl;dr

4 messages between Nov 14, 2005 and Nov 14, 2005. Diffs are folded; open one to read it.

replies: 3people: 1as markdown or json

Nikolai Weibull· Nov 14, 2005, 23:20 UTC · lore

While going over my Zsh-completion functions I found some options still missing from the documentation. I also found some problems with some of the documentation, so I fixed them as well.

        nikolai

 Documentation/git-checkout-index.txt |   10 +++++-----
 Documentation/git-commit-tree.txt    |    2 +-
 Documentation/git-prune-packed.txt   |    6 ++++++
 Documentation/git-read-tree.txt      |    4 ++++
 Documentation/git-unpack-objects.txt |    6 +++++-
 Documentation/git-update-index.txt   |    2 +-
 unpack-objects.c                     |    2 +-
 7 files changed, 23 insertions(+), 9 deletions(-)

Nikolai Weibull· Nov 14, 2005, 23:20 UTC · re: Nikolai Weibull · lore

[PATCH 1/3] Document the -n command-line option to git-unpack-objects

This patch documents the -n command-line option to git-unpack-objects, as it was previously undocumented.

Signed-off-by: Nikolai Weibull <nikolai@bitwi.se>

---

 Documentation/git-unpack-objects.txt |    6 +++++-
 unpack-objects.c                     |    2 +-
 2 files changed, 6 insertions(+), 2 deletions(-)

applies-to: 963d67921d6f65c08d51a8c93811f03274c34703 0d2b0b51463fe0fed667a7169b94d7ee52677e69

Show changes to 2 files +6 −2

Documentation/git-unpack-objects.txt, unpack-objects.c

diff --git a/Documentation/git-unpack-objects.txt b/Documentation/git-unpack-objects.txt
index b716ba1..31ea34d 100644
--- a/Documentation/git-unpack-objects.txt
+++ b/Documentation/git-unpack-objects.txt
@@ -8,7 +8,7 @@ git-unpack-objects - Unpack objects from
 
 SYNOPSIS
 --------
-'git-unpack-objects' [-q] <pack-file
+'git-unpack-objects' [-n] [-q] <pack-file
 
 
 DESCRIPTION
@@ -19,6 +19,10 @@ one-object" format in $GIT_OBJECT_DIRECT
 
 OPTIONS
 -------
+-n::
+        Only list the objects that would be unpacked, don't actually unpack
+        them.
+
 -q::
 	The command usually shows percentage progress.  This
 	flag suppresses it.
diff --git a/unpack-objects.c b/unpack-objects.c
index 8ae1a1c..8490895 100644
--- a/unpack-objects.c
+++ b/unpack-objects.c
@@ -6,7 +6,7 @@
 #include <sys/time.h>
 
 static int dry_run, quiet;
-static const char unpack_usage[] = "git-unpack-objects [-q] < pack-file";
+static const char unpack_usage[] = "git-unpack-objects [-n] [-q] < pack-file";
 
 /* We always read in 4kB chunks. */
 static unsigned char buffer[4096];
---
0.99.9g

Nikolai Weibull· Nov 14, 2005, 23:20 UTC · re: Nikolai Weibull · lore

[PATCH 2/3] Document a couple of missing command-line options.

This patch adds documentation to quite a few command-line options.

Signed-off-by: Nikolai Weibull <nikolai@bitwi.se>

---

 Documentation/git-checkout-index.txt |   10 +++++-----
 Documentation/git-prune-packed.txt   |    6 ++++++
 Documentation/git-read-tree.txt      |    4 ++++
 3 files changed, 15 insertions(+), 5 deletions(-)

applies-to: fc4d52c0050cf3af0aa501ba7e33d3e0622f0fdc 798cec0159df6f4fefd35c63ad4a59a0399bbd22

Show changes to 3 files +15 −5

Documentation/git-checkout-index.txt, Documentation/git-prune-packed.txt, Documentation/git-read-tree.txt

diff --git a/Documentation/git-checkout-index.txt b/Documentation/git-checkout-index.txt
index 94b283a..5bff486 100644
--- a/Documentation/git-checkout-index.txt
+++ b/Documentation/git-checkout-index.txt
@@ -18,21 +18,21 @@ Will copy all files listed from the inde
 
 OPTIONS
 -------
--u::
+-u|--index::
 	update stat information for the checked out entries in
 	the index file.
 
--q::
+-q|--quiet::
 	be quiet if files exist or are not in the index
 
--f::
+-f|--force::
 	forces overwrite of existing files
 
--a::
+-a|--all::
 	checks out all files in the index.  Cannot be used
 	together with explicit filenames.
 
--n::
+-n|--no-create::
 	Don't checkout new files, only refresh files already checked
 	out.
 
diff --git a/Documentation/git-prune-packed.txt b/Documentation/git-prune-packed.txt
index 28a1500..8d96a91 100644
--- a/Documentation/git-prune-packed.txt
+++ b/Documentation/git-prune-packed.txt
@@ -23,6 +23,12 @@ compression applied, stored in a single 
 
 Packs are used to reduce the load on mirror systems, backup engines, disk storage, etc.
 
+OPTIONS
+-------
+-n::
+        Don't actually remove any objects, only show those that would have been
+        removed.
+
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>
diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt
index e219c6a..7be0cbd 100644
--- a/Documentation/git-read-tree.txt
+++ b/Documentation/git-read-tree.txt
@@ -30,6 +30,10 @@ OPTIONS
 -m::
 	Perform a merge, not just a read.
 
+--reset::
+
+        Same as -m except that unmerged entries will be silently ignored.
+
 -u::
 	After a successful merge, update the files in the work
 	tree with the result of the merge.
---
0.99.9g

Nikolai Weibull· Nov 14, 2005, 23:20 UTC · re: Nikolai Weibull · lore

[PATCH 3/3] Documentation nitpicking

This patch fixes some small problems with the documentation.

Signed-off-by: Nikolai Weibull <nikolai@bitwi.se>

---

 Documentation/git-commit-tree.txt  |    2 +-
 Documentation/git-update-index.txt |    2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

applies-to: 118fb90e721428900a0588074894a4b198044762 683a61f6648873de0a73c8c60a86064cf4f4911d

Show changes to 2 files +2 −2

Documentation/git-commit-tree.txt, Documentation/git-update-index.txt

diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt
index b64cd6a..5cf6bd3 100644
--- a/Documentation/git-commit-tree.txt
+++ b/Documentation/git-commit-tree.txt
@@ -8,7 +8,7 @@ git-commit-tree - Creates a new commit o
 
 SYNOPSIS
 --------
-'git-commit-tree' <tree> [-p <parent commit>]\   < changelog
+'git-commit-tree' <tree> [-p <parent commit>]\* < changelog
 
 DESCRIPTION
 -----------
diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt
index 52874c8..fdcb8be 100644
--- a/Documentation/git-update-index.txt
+++ b/Documentation/git-update-index.txt
@@ -60,7 +60,7 @@ OPTIONS
 	Directly insert the specified info into the index.
 	
 --index-info::
-        Read index info from stdin.
+        Read index information from stdin.
 
 --chmod=(+|-)x::
         Set the execute permissions on the updated files.        
---
0.99.9g