public inbox for jit@gcc.gnu.org
 help / color / mirror / Atom feed
From: Gerald Pfeifer <gerald@pfeifer.com>
To: David Malcolm <dmalcolm@redhat.com>
Cc: jit@gcc.gnu.org, gcc-patches@gcc.gnu.org
Subject: Re: [PATCH] update_web_docs_svn: support the JIT docs (PR jit/64257)
Date: Thu, 01 Jan 2015 00:00:00 -0000	[thread overview]
Message-ID: <alpine.LSU.2.11.1501261235560.2527@tuna.site> (raw)
In-Reply-To: <1422053051-11954-1-git-send-email-dmalcolm@redhat.com>

On Friday 2015-01-23 17:44, David Malcolm wrote:
> The following patch builds and installs the JIT documentation for
> the website (just HTML for now).
> 
> It's tricky to test (I don't have a copy of /www/gcc/bin/preprocess),
> but I was able to use this to generate sane-looking documentation,
> both for the .texi files, and for the JIT documentation.

You can easily get the preprocess script by checking out wwwdocs,
cf. https://gcc.gnu.org/about.html.

That still will require MetaHTML which, sadly, became an abandoned
FSF project, and will require a hack or two to build, so let's just
go with your patch.

A few notes, though:

> maintainer-scripts/ChangeLog:
> 	PR jit/64257
> 	* update_web_docs_svn: Don't delete gcc/jit/docs,
> 	since the jit docs are not .tex files (Makefile, .rst and
> 	.png).	Special-case the building of the JIT docs (using
> 	sphinx-build).  Special-case copying them up (since they
> 	contain .css, .js and .png files in addition to .html, and
> 	have nested subdirectories).

The "since" should be part of the code, not the ChangeLog.

> diff --git a/maintainer-scripts/update_web_docs_svn b/maintainer-scripts/update_web_docs_svn
> index c661220..c7eb890 100755
> --- a/maintainer-scripts/update_web_docs_svn
> +++ b/maintainer-scripts/update_web_docs_svn
> +# The JIT is a special-case, using sphinx rather than texinfo.

special case

> +# The jit Makefile uses "sphinx-build", which is packaged in
> +# Fedora and EPEL 6 within "python-sphinx".

JIT (above) vs jit (here)?

How about saying "...packaged in "python-sphinx" in Fedora and
EPEL 6 and in "python-Sphinx" in openSUSE"?

> +# Again, the jit is a special case, with nested subdirectories
> +# below "jit", and with some non-HTML files (.png images from us,
> +# plus .js and .css supplied by sphinx).
> +for file in $(find jit \
> +                -name "*.html" -o -name "*.css" \
> +                -o -name "*.js" -o -name "*.png"); do

This looks like a Bash-ism.  Can you use backticks of something
like 

  find ... | while read file; ...

?

> +    cp $file $DOCSDIR/$file

Just "cp $file $DOCSDIR/" ?  This one may be a better of style,
but is easier to tweak in case we need to quote later on, for
example.

Gerald

  reply	other threads:[~2015-01-26 11:43 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-01-01  0:00 David Malcolm
2015-01-01  0:00 ` Gerald Pfeifer [this message]
2015-01-01  0:00   ` Mike Stump
2015-01-01  0:00   ` David Malcolm
2015-01-01  0:00     ` Jeff Law
2015-01-01  0:00       ` David Malcolm
2015-01-01  0:00         ` [PING, www] " David Malcolm
2015-01-01  0:00           ` Gerald Pfeifer
2015-01-01  0:00             ` [PATCH] More fixes for update_web_docs_svn for jit " David Malcolm
2015-01-01  0:00               ` Gerald Pfeifer
2015-01-01  0:00                 ` David Malcolm
2015-01-01  0:00                   ` Gerald Pfeifer
2015-01-01  0:00                     ` David Malcolm
2015-01-01  0:00                       ` [PATCH] maintainer-scripts: Fix 404s in "Show Source" in jit docs David Malcolm
2015-01-01  0:00                         ` Gerald Pfeifer
2015-01-01  0:00                       ` [PATCH] More fixes for update_web_docs_svn for jit docs (PR jit/64257) David Malcolm
2019-01-01  0:00                       ` Gerald Pfeifer
2015-01-01  0:00               ` Andrew Pinski

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=alpine.LSU.2.11.1501261235560.2527@tuna.site \
    --to=gerald@pfeifer.com \
    --cc=dmalcolm@redhat.com \
    --cc=gcc-patches@gcc.gnu.org \
    --cc=jit@gcc.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).