On Sat, 11 Mar 2023, Arsen Arsenović wrote:
> OK, changed up a bit, what do you think of this:
> maintainer-scripts/ChangeLog:
>
> * update_web_docs_git: Set CONTENTS_OUTPUT_LOCATION=inline in
> order to put @shortcontents above contents. See
> 9dd976a4-4e09-d901-b949-6d5037567...@codesourcery.com on
> gcc-patches.
In the ChangeLog we only describe *what* has change, so the first half of
the first sentence.
The rest then goes in between the first line of the Git commit message
(= the subject of your mail) and the ChangeLog entries.
> --- a/gcc/configure
> +++ b/gcc/configure
We usually don't post diffs for generated files. Not a biggie, I figured I
mention it since it makes reviewing easier and patches shorter, and thus
tends to increase the chance reviewers short on time jump in. :-)
> --- a/maintainer-scripts/update_web_docs_git
> +++ b/maintainer-scripts/update_web_docs_git
> @@ -169,7 +169,7 @@ for file in $MANUALS; do
> if [ "$file" = "gnat_ugn" ]; then
> includes="$includes -I gcc/gcc/ada -I gcc/gcc/ada/doc/gnat_ugn"
> fi
> - makeinfo --html --css-ref $CSS $includes -o ${file} ${filename}
> + makeinfo --html -c CONTENTS_OUTPUT_LOCATION=inline --css-ref $CSS
> $includes -o ${file} ${filename}
Sandra deferred to me on this one, so explicitly: Ack, thank you. :-)
Note, update_web_docs_git runs once a day, at 0:50 GMT, see
gcc/maintainer-scripts/crontab, and needs to be updated on the gcc.gnu.org
system. I am happy to do that for you, just drop me a note when the commit
is in.
Gerald
