Minor fast-import documentation corrections.
Corrected a couple of header markup lines which were shorter than the actual header, and made the `data` commands two formats into a named list, which matches how we document the two formats of the `M` command within a commit. Also tried to simplify the language about our decimal integer format; Linus pointed out I was probably being too specific at the cost of reduced readability. Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
Shawn O. Pearce committed
Feb 6, 2007 at 12:35 UTC
ef94edb53c9a5fd1e5fca9f548adc713d3d8ffe1
1 file changed
+18
-14
Documentation/git-fast-import.txt
+18
-14
@@ -224,7 +224,7 @@ the email address from the other fields in the line. Note that
224
225
The time of the change is specified by `<time>` as the number of
226
seconds since the UNIX epoc (midnight, Jan 1, 1970, UTC) and is
227
-written in base-10 notation using US-ASCII digits. The committer's
227
+written as an ASCII decimal integer. The committer's
228
timezone is specified by `<tz>` as a positive or negative offset
229
from UTC. For example EST (which is typically 5 hours behind GMT)
230
would be expressed in `<tz>` by ``-0500'' while GMT is ``+0000''.
@@ -293,7 +293,7 @@ Here `<committish>` is any of the commit specification expressions
293
also accepted by `from` (see above).
294
295
`filemodify`
296
-^^^^^^^^^^
296
+^^^^^^^^^^^^
297
Included in a `commit` command to add a new file or change the
298
content of an existing file. This command has two different means
299
of specifying the content of the file.
@@ -351,9 +351,8 @@ The value of `<path>` must be in canoncial form. That is it must not:
351
352
It is recommended that `<path>` always be encoded using UTF-8.
353
354
-
354
`filedelete`
356
-^^^^^^^^^^
355
+^^^^^^^^^^^^
356
Included in a `commit` command to remove a file from the branch.
357
If the file removal makes its directory empty, the directory will
358
be automatically removed too. This cascades up the tree until the
@@ -379,8 +378,8 @@ command the `mark` command appears within. This can be `commit`,
378
....
379
380
where `<idnum>` is the number assigned by the frontend to this mark.
382
-The value of `<idnum>` is expressed in base 10 notation using
383
-US-ASCII digits. The value 0 is reserved and cannot be used as
381
+The value of `<idnum>` is expressed as an ASCII decimal integer.
382
+The value 0 is reserved and cannot be used as
383
a mark. Only values greater than or equal to 1 may be used as marks.
384
385
New marks are created automatically. Existing marks can be moved
@@ -485,26 +484,31 @@ intended for production-quality conversions should always use the
484
exact byte count format, as it is more robust and performs better.
485
The delimited format is intended primarily for testing gfi.
486
488
-Exact byte count format:
489
-
487
+Exact byte count format::
488
+ The frontend must specify the number of bytes of data.
489
++
490
....
491
'data' SP <count> LF
492
<raw> LF
493
....
494
-
494
++
495
where `<count>` is the exact number of bytes appearing within
496
-`<raw>`. The value of `<count>` is expressed in base 10 notation
497
-using US-ASCII digits. The `LF` on either side of `<raw>` is not
496
+`<raw>`. The value of `<count>` is expressed as an ASCII decimal
497
+integer. The `LF` on either side of `<raw>` is not
498
included in `<count>` and will not be included in the imported data.
499
500
-Delimited format:
501
-
500
+Delimited format::
501
+ A delimiter string is used to mark the end of the data.
502
+ gfi will compute the length by searching for the delimiter.
503
+ This format is primarly useful for testing and is not
504
+ recommended for real data.
505
++
506
....
507
'data' SP '<<' <delim> LF
508
<raw> LF
509
<delim> LF
510
....
507
-
511
++
512
where `<delim>` is the chosen delimiter string. The string `<delim>`
513
must not appear on a line by itself within `<raw>`, as otherwise
514
gfi will think the data ends earlier than it really does. The `LF`