From: David Malcolm <dmalcolm@redhat.com>
To: "Arsen Arsenović" <arsen@aarsen.me>, gcc-patches@gcc.gnu.org
Cc: "Martin Liška" <mliska@suse.cz>
Subject: Re: [PATCH] doc: Use a separate directory for new modules we add to PATH
Date: Wed, 09 Nov 2022 17:18:21 -0500 [thread overview]
Message-ID: <05bf6ca95eda52619503001e7e8a5ba6c975dfb7.camel@redhat.com> (raw)
In-Reply-To: <20221109213132.2698221-1-arsen@aarsen.me>
On Wed, 2022-11-09 at 22:31 +0100, Arsen Arsenović via Gcc-patches
wrote:
> ChangeLog:
>
> * doc/baseconf.py: Inject dirname(__file__)/'modules' to path
> instead of just ``.''.
> * doc/gcc_sphinx.py: Moved to...
> * doc/modules/gcc_sphinx.py: ...here.
> ---
> Evening,
>
> This patch addresses a path mixup
FWIW this patch fixes the build of the docs for me; without it I run
into the "Could not import extension gcc_sphinx (exception: No module
named 'gcc_sphinx')" issue we were discussing on IRC.
Thanks!
Dave
> and provides a nice compromise between
> convenience for the user and namespace cleanliness. Further modules
> that Sphinx imports internally from the GCC tree should also go into
> this directory. I moved gcc_sphinx since I knew of that one, but
> there
> could be others I'm missing.
>
> Tested on x86_64-pc-linux-gnu with ``make html''.
>
> Have a great night!
>
> doc/baseconf.py | 4 +++-
> doc/{ => modules}/gcc_sphinx.py | 0
> 2 files changed, 3 insertions(+), 1 deletion(-)
> rename doc/{ => modules}/gcc_sphinx.py (100%)
>
> diff --git a/doc/baseconf.py b/doc/baseconf.py
> index 47e3a126416..d85659e4540 100644
> --- a/doc/baseconf.py
> +++ b/doc/baseconf.py
> @@ -13,7 +13,6 @@
> import os
> import time
> import sys
> -# sys.path.insert(0, os.path.abspath('.'))
>
> # gccint needs a deeper stack limit
> sys.setrecursionlimit(2000)
> @@ -23,8 +22,11 @@ sys.setrecursionlimit(2000)
> # The full version, including alpha/beta/rc tags
>
> folder = os.path.dirname(os.path.realpath(__file__))
> +doc_modules = os.path.join(folder, 'modules')
> gcc_srcdir = os.path.join(folder, '..', 'gcc')
>
> +sys.path.insert(0, doc_modules)
> +
> def read_file(name):
> path = os.path.join(gcc_srcdir, name)
> if os.path.exists(path):
> diff --git a/doc/gcc_sphinx.py b/doc/modules/gcc_sphinx.py
> similarity index 100%
> rename from doc/gcc_sphinx.py
> rename to doc/modules/gcc_sphinx.py
next prev parent reply other threads:[~2022-11-09 22:18 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-09 21:31 Arsen Arsenović
2022-11-09 22:18 ` David Malcolm [this message]
2022-11-10 5:26 ` Martin Liška
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=05bf6ca95eda52619503001e7e8a5ba6c975dfb7.camel@redhat.com \
--to=dmalcolm@redhat.com \
--cc=arsen@aarsen.me \
--cc=gcc-patches@gcc.gnu.org \
--cc=mliska@suse.cz \
/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).