git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 4/6] fast-import doc: change "bob" in an example to "file.txt"

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Jun 15, 2021, 16:18 UTC
Message-ID
<patch-4.6-0b464dc51d8-20210615T161330Z-avarab@gmail.com>
In-Reply-To
<cover-0.6-00000000000-20210615T161330Z-avarab@gmail.com>

The example added in e7e5170f804 (Update fast-import documentation to discuss crash reports, 2008-02-14) is a bit confusing in that we're referring to a "bob" when we really just need a placeholder name for a file that has bad mode bits, let's use "file.txt" instead.

Let's also use "<<-" in the here-doc so this'll work if the reader copies this from e.g. a tab-indented manual page, none of the content needs leading whitespace, so that won't break anything if the content isn't indented.

The fast-import error message and other output has also changed slightly since 2008, let's update the relevant parts of it, while retaining the original PID, time etc. of the 2007-era example.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 Documentation/git-fast-import.txt | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)
diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt
index 39cfa05b28b..ddaa8e5d755 100644
--- a/Documentation/git-fast-import.txt
+++ b/Documentation/git-fast-import.txt
@@ -1277,7 +1277,7 @@ must be applied manually if the update is needed.
 An example crash:
 
 ====
-	$ cat >in <<END_OF_INPUT
+	$ cat >in <<-END_OF_INPUT
 	# my very first test commit
 	commit refs/heads/master
 	committer Shawn O. Pearce <spearce> 19283 -0400
@@ -1289,12 +1289,13 @@ An example crash:
 	data <<EOF
 	.gitignore
 	EOF
-	M 777 inline bob
+	M 777 inline file.txt
 	END_OF_INPUT
 
 	$ git fast-import <in
-	fatal: Corrupt mode: M 777 inline bob
+	fatal: Corrupt mode: M 777 inline file.txt
 	fast-import: dumping crash report to .git/fast_import_crash_8434
+	Unpacking objects: 100% (1/1), 32 bytes | 32.00 KiB/s, done.
 
 	$ cat .git/fast_import_crash_8434
 	fast-import crash report:
@@ -1302,7 +1303,7 @@ An example crash:
 	    parent process     : 1391
 	    at Sat Sep 1 00:58:12 2007
 
-	fatal: Corrupt mode: M 777 inline bob
+	fatal: Corrupt mode: M 777 inline file.txt
 
 	Most Recent Commands Before Crash
 	---------------------------------
@@ -1313,7 +1314,7 @@ An example crash:
 	  data <<EOF
 	  M 644 inline .gitignore
 	  data <<EOF
-	* M 777 inline bob
+	* M 777 inline file.txt
 
 	Active Branch LRU
 	-----------------
@@ -1334,6 +1335,9 @@ An example crash:
 	  last pack   :
 
 
+	Marks
+	-----
+
 	-------------------
 	END OF CRASH REPORT
 ====
-- 
2.32.0.555.g0268d380f7b
Previous: Ævar Arnfjörð BjarmasonNext: Ævar Arnfjörð Bjarmason
Message 10 of 24 in “doc: replace "alice" and "bob" examples”
  1. 0/6 doc: replace "alice" and "bob" examplesÆvar Arnfjörð Bjarmason, Jun 15, 2021
  2. 1/6 gittutorial doc: replace "alice" and "bob" with "you" and "www-data"Ævar Arnfjörð Bjarmason, Jun 15, 2021
  3. Bagas SanjayaJun 16, 2021
  4. Junio C HamanoJun 16, 2021
  5. Felipe ContrerasJun 16, 2021
  6. Ævar Arnfjörð BjarmasonJun 17, 2021
  7. 2/6 gitcvs-migration doc: replace "alice" and "bob" with "you" and "www-data"Ævar Arnfjörð Bjarmason, Jun 15, 2021
  8. Bagas SanjayaJun 16, 2021
  9. 3/6 daemon doc + code comments: reword "alice" exampleÆvar Arnfjörð Bjarmason, Jun 15, 2021
  10. 4/6 fast-import doc: change "bob" in an example to "file.txt"Ævar Arnfjörð Bjarmason, Jun 15, 2021
  11. 5/6 doc: replace "alice" and "bob" with "jdoe" and "msmith"Ævar Arnfjörð Bjarmason, Jun 15, 2021
  12. 6/6 pack-protocol doc: use "www-data" in place of "alice"Ævar Arnfjörð Bjarmason, Jun 15, 2021
  13. Robert P. J. DayJun 15, 2021
  14. Ævar Arnfjörð BjarmasonJun 15, 2021
  15. Felipe ContrerasJun 15, 2021
  16. Ævar Arnfjörð BjarmasonJun 15, 2021
  17. Felipe ContrerasJun 16, 2021
  18. Phillip SusiJun 17, 2021
  19. Ævar Arnfjörð BjarmasonJun 17, 2021
  20. Junio C HamanoJun 16, 2021
  21. Robert P. J. DayJun 16, 2021
  22. Jeff KingJun 16, 2021
  23. Felipe ContrerasJun 16, 2021
  24. Randall S. BeckerJun 16, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.