From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Derrick Stolee" <stolee@gmail.com>, "Jeff King" <peff@peff.net>,
"Felipe Contreras" <felipe.contreras@gmail.com>,
"Bagas Sanjaya" <bagasdotme@gmail.com>,
"Robert Karszniewicz" <avoidr@posteo.de>,
"Emily Shaffer" <emilyshaffer@google.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: [PATCH 4/6] fast-import doc: change "bob" in an example to "file.txt"
Date: Tue, 15 Jun 2021 18:18:01 +0200 [thread overview]
Message-ID: <patch-4.6-0b464dc51d8-20210615T161330Z-avarab@gmail.com> (raw)
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
next prev parent reply other threads:[~2021-06-15 16:19 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-15 16:17 [PATCH 0/6] doc: replace "alice" and "bob" examples Ævar Arnfjörð Bjarmason
2021-06-15 16:17 ` [PATCH 1/6] gittutorial doc: replace "alice" and "bob" with "you" and "www-data" Ævar Arnfjörð Bjarmason
2021-06-16 3:43 ` Bagas Sanjaya
2021-06-16 4:50 ` Junio C Hamano
2021-06-16 21:04 ` Felipe Contreras
2021-06-17 20:38 ` Ævar Arnfjörð Bjarmason
2021-06-15 16:17 ` [PATCH 2/6] gitcvs-migration " Ævar Arnfjörð Bjarmason
2021-06-16 4:02 ` Bagas Sanjaya
2021-06-15 16:18 ` [PATCH 3/6] daemon doc + code comments: reword "alice" example Ævar Arnfjörð Bjarmason
2021-06-15 16:18 ` Ævar Arnfjörð Bjarmason [this message]
2021-06-15 16:18 ` [PATCH 5/6] doc: replace "alice" and "bob" with "jdoe" and "msmith" Ævar Arnfjörð Bjarmason
2021-06-15 16:18 ` [PATCH 6/6] pack-protocol doc: use "www-data" in place of "alice" Ævar Arnfjörð Bjarmason
2021-06-15 16:46 ` [PATCH 0/6] doc: replace "alice" and "bob" examples Robert P. J. Day
2021-06-15 18:45 ` Ævar Arnfjörð Bjarmason
2021-06-15 16:54 ` Felipe Contreras
2021-06-15 19:09 ` Ævar Arnfjörð Bjarmason
2021-06-16 20:56 ` Felipe Contreras
2021-06-17 15:48 ` Phillip Susi
2021-06-17 20:51 ` Ævar Arnfjörð Bjarmason
2021-06-16 1:52 ` Junio C Hamano
2021-06-16 9:30 ` Robert P. J. Day
2021-06-16 12:00 ` Jeff King
2021-06-16 20:59 ` Felipe Contreras
2021-06-16 21:02 ` Randall S. Becker
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=patch-4.6-0b464dc51d8-20210615T161330Z-avarab@gmail.com \
--to=avarab@gmail.com \
--cc=avoidr@posteo.de \
--cc=bagasdotme@gmail.com \
--cc=emilyshaffer@google.com \
--cc=felipe.contreras@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
--cc=stolee@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).