@matheusbsbs / matheus-bagliano / commits / 8a33dd8b6e
Fork 0

attribute documentation: keep EXAMPLE at end

The document gives overall definition of states in DESCRIPTION, describes various aspects of git operations that can be influenced in EFFECTS, and finally gives examples in the EXAMPLE section. Archive creation however was somehow documented after the EXAMPLE section, not insode EFFECTS. Signed-off-by: Junio C Hamano <gitster@pobox.com>

Junio C Hamano committed Jul 5, 2008 at 18:14 UTC 8a33dd8b6e29722e86556c178d7c0b963804f0d3
1 file changed +17 -16
Documentation/gitattributes.txt
+17 -16
@@ -450,6 +450,23 @@ String::
450 variable.
451
452
453 +Creating an archive
454 +~~~~~~~~~~~~~~~~~~~
455 +
456 +`export-subst`
457 +^^^^^^^^^^^^^^
458 +
459 +If the attribute `export-subst` is set for a file then git will expand
460 +several placeholders when adding this file to an archive. The
461 +expansion depends on the availability of a commit ID, i.e. if
462 +linkgit:git-archive[1] has been given a tree instead of a commit or a
463 +tag then no replacement will be done. The placeholders are the same
464 +as those for the option `--pretty=format:` of linkgit:git-log[1],
465 +except that they need to be wrapped like this: `$Format:PLACEHOLDERS$`
466 +in the file. E.g. the string `$Format:%H$` will be replaced by the
467 +commit hash.
468 +
469 +
470 EXAMPLE
471 -------
472
@@ -499,22 +516,6 @@ frotz unspecified
516 ----------------------------------------------------------------
517
518
502 -Creating an archive
503 -~~~~~~~~~~~~~~~~~~~
504 -
505 -`export-subst`
506 -^^^^^^^^^^^^^^
507 -
508 -If the attribute `export-subst` is set for a file then git will expand
509 -several placeholders when adding this file to an archive. The
510 -expansion depends on the availability of a commit ID, i.e. if
511 -linkgit:git-archive[1] has been given a tree instead of a commit or a
512 -tag then no replacement will be done. The placeholders are the same
513 -as those for the option `--pretty=format:` of linkgit:git-log[1],
514 -except that they need to be wrapped like this: `$Format:PLACEHOLDERS$`
515 -in the file. E.g. the string `$Format:%H$` will be replaced by the
516 -commit hash.
517 -
519
520 GIT
521 ---