@matheusbsbs / matheus-bagliano / commits / 83b0b8953e

doc-diff: replace --cut-header-footer with --cut-footer

After the previous commit, AsciiDoc and Asciidoctor render the manpage headers identically, so we no longer need the "cut the header" part of our `--cut-header-footer` option. We do still need the "cut the footer" part, though. The previous commits improved the rendering of the footer in Asciidoctor by quite a bit, but the two programs still disagree on how to format the date in the footer: 01/01/1970 vs 1970-01-01. We could keep using `--cut-header-footer`, but it would be nice if we had a slightly smaller hammer `--cut-footer` that would be less likely to hide regressions. Rather than simply adding such an option, let's also drop `--cut-header-footer`, i.e., rework it to lose the "header" part of its name and functionality. `--cut-header-footer` is just a developer tool and it probably has no more than a handful of users, so we can afford to be aggressive. Signed-off-by: Martin Ågren <martin.agren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Martin Ågren committed Sep 16, 2019 at 21:00 UTC 83b0b8953ee725068137714b04fd943893ab392e
1 file changed +8 -9
Documentation/doc-diff
+8 -9
@@ -21,7 +21,7 @@ asciidoc use asciidoc with both commits
21 to-asciidoc use asciidoc with the 'to'-commit
22 to-asciidoctor use asciidoctor with the 'to'-commit
23 asciidoctor use asciidoctor with both commits
24 -cut-header-footer cut away header and footer
24 +cut-footer cut away footer
25 "
26 SUBDIRECTORY_OK=1
27 . "$(git --exec-path)/git-sh-setup"
@@ -31,7 +31,7 @@ force=
31 clean=
32 from_program=
33 to_program=
34 -cut_header_footer=
34 +cut_footer=
35 while test $# -gt 0
36 do
37 case "$1" in
@@ -55,8 +55,8 @@ do
55 --asciidoc)
56 from_program=-asciidoc
57 to_program=-asciidoc ;;
58 - --cut-header-footer)
59 - cut_header_footer=-cut-header-footer ;;
58 + --cut-footer)
59 + cut_footer=-cut-footer ;;
60 --)
61 shift; break ;;
62 *)
@@ -118,8 +118,8 @@ construct_makemanflags () {
118 from_makemanflags=$(construct_makemanflags "$from_program") &&
119 to_makemanflags=$(construct_makemanflags "$to_program") &&
120
121 -from_dir=$from_oid$from_program$cut_header_footer &&
122 -to_dir=$to_oid$to_program$cut_header_footer &&
121 +from_dir=$from_oid$from_program$cut_footer &&
122 +to_dir=$to_oid$to_program$cut_footer &&
123
124 # generate_render_makefile <srcdir> <dstdir>
125 generate_render_makefile () {
@@ -169,12 +169,11 @@ render_tree () {
169 make -j$parallel -f - &&
170 mv "$tmp/rendered/$dname+" "$tmp/rendered/$dname"
171
172 - if test "$cut_header_footer" = "-cut-header-footer"
172 + if test "$cut_footer" = "-cut-footer"
173 then
174 for f in $(find "$tmp/rendered/$dname" -type f)
175 do
176 - tail -n +3 "$f" | head -n -2 |
177 - sed -e '1{/^$/d}' -e '${/^$/d}' >"$f+" &&
176 + head -n -2 "$f" | sed -e '${/^$/d}' >"$f+" &&
177 mv "$f+" "$f" ||
178 return 1
179 done