Skip to content

Commit 83b0b89

Browse files
Martin Ågrengitster
Martin Ågren
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 7a30134 commit 83b0b89

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

Documentation/doc-diff

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ asciidoc use asciidoc with both commits
2121
to-asciidoc use asciidoc with the 'to'-commit
2222
to-asciidoctor use asciidoctor with the 'to'-commit
2323
asciidoctor use asciidoctor with both commits
24-
cut-header-footer cut away header and footer
24+
cut-footer cut away footer
2525
"
2626
SUBDIRECTORY_OK=1
2727
. "$(git --exec-path)/git-sh-setup"
@@ -31,7 +31,7 @@ force=
3131
clean=
3232
from_program=
3333
to_program=
34-
cut_header_footer=
34+
cut_footer=
3535
while test $# -gt 0
3636
do
3737
case "$1" in
@@ -55,8 +55,8 @@ do
5555
--asciidoc)
5656
from_program=-asciidoc
5757
to_program=-asciidoc ;;
58-
--cut-header-footer)
59-
cut_header_footer=-cut-header-footer ;;
58+
--cut-footer)
59+
cut_footer=-cut-footer ;;
6060
--)
6161
shift; break ;;
6262
*)
@@ -118,8 +118,8 @@ construct_makemanflags () {
118118
from_makemanflags=$(construct_makemanflags "$from_program") &&
119119
to_makemanflags=$(construct_makemanflags "$to_program") &&
120120

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 &&
123123

124124
# generate_render_makefile <srcdir> <dstdir>
125125
generate_render_makefile () {
@@ -169,12 +169,11 @@ render_tree () {
169169
make -j$parallel -f - &&
170170
mv "$tmp/rendered/$dname+" "$tmp/rendered/$dname"
171171

172-
if test "$cut_header_footer" = "-cut-header-footer"
172+
if test "$cut_footer" = "-cut-footer"
173173
then
174174
for f in $(find "$tmp/rendered/$dname" -type f)
175175
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+" &&
178177
mv "$f+" "$f" ||
179178
return 1
180179
done

0 commit comments

Comments
 (0)