Message ID | 7e41c1dd-d95a-0769-bfb5-c3713da240ab@suse.cz |
---|---|
State | New, archived |
Headers |
Return-Path: <gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:6a10:b5d6:b0:2b9:3548:2db5 with SMTP id v22csp1668473pxt; Mon, 25 Jul 2022 07:00:34 -0700 (PDT) X-Google-Smtp-Source: AGRyM1tcF1YCsuWLfy0vnaKvVVWHCExl/GLBubHsxCFUEueJpv5CGe8COlg/r/AItjsnBysXWkVP X-Received: by 2002:aa7:d994:0:b0:43b:d187:69fd with SMTP id u20-20020aa7d994000000b0043bd18769fdmr13312979eds.201.1658757634002; Mon, 25 Jul 2022 07:00:34 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1658757633; cv=none; d=google.com; s=arc-20160816; b=pm60KpPZfmuU6n6n2gbqUQrBHXw5y3p8K+76xLwY0nGXOoEVTiCinsWVR7Bbl7ClQ1 MAO95DVLw2EAMN4eBuTB0KqlAyMXWIQ5MbLFwgChcpljJK5CSLoWRh2xgkDcCc8A3zDd oLYtpoynRMmRSVjb7zRDH4bydj8nO8e30rYaRL9l2TRiVirpF6pjeIyh7CFQyVtFqkMb Sf46eoeGlxZuMkgBbBs+WuFfcnez1nEbb9xxutrgC3X2kKo1ANhuDqJvIIedVjMoV/g1 csAoQa7jvefJL8xz77cZvtGZmqA2tSQlzMaMb9XahP9X4iD2hCSY4qKVYe17KWc8u62Q dzRg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :content-language:to:subject:from:user-agent:mime-version:date :message-id:dkim-signature:dkim-signature:dmarc-filter:delivered-to; bh=bu3M5eKyYZbGOp87AU8OMfwUpudhWTolLRwEL6PfLKY=; b=QeiHuVzpaI82MCm6Bq2OYnXFtViugpKeNlx8n9sDwbtLOt28neYeTAIviWXbpOEFMf 3n7rEUE+/DRRoXBTDSC6m6WiFkmqULqdtmeMqQbDhpQCjBF7/y/l388ow8p8yG3lM6u6 dmkBK3OU7JMTJDsEK1TQW2OLsj4m2afmt3Ta2Tanfox08ewxLMllJ57FewSJZiceGMgw +KMWxKQZX3nZV0n5KHkeb+HnnPkw+L7L9vI8xO3qHnFQaSDxM9wYi3WTX9eQquY9BnO6 DqENFfrbTLxYIug2ywuVY0gyiwsDHL2Xb027ZDlB0grtJqqRDZ1Ly99sd0aiU8+G2LM7 8TOQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@suse.cz header.s=susede2_rsa header.b=rrhnYtLc; dkim=neutral (no key) header.i=@suse.cz header.s=susede2_ed25519 header.b=fC+zXySA; spf=pass (google.com: domain of gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org designates 8.43.85.97 as permitted sender) smtp.mailfrom="gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org" Received: from sourceware.org (server2.sourceware.org. [8.43.85.97]) by mx.google.com with ESMTPS id by8-20020a170906a2c800b0072b97ce764esi11377345ejb.214.2022.07.25.07.00.33 for <ouuuleilei@gmail.com> (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 25 Jul 2022 07:00:33 -0700 (PDT) Received-SPF: pass (google.com: domain of gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org designates 8.43.85.97 as permitted sender) client-ip=8.43.85.97; Authentication-Results: mx.google.com; dkim=pass header.i=@suse.cz header.s=susede2_rsa header.b=rrhnYtLc; dkim=neutral (no key) header.i=@suse.cz header.s=susede2_ed25519 header.b=fC+zXySA; spf=pass (google.com: domain of gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org designates 8.43.85.97 as permitted sender) smtp.mailfrom="gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org" Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 4E9DE383B7A5 for <ouuuleilei@gmail.com>; Mon, 25 Jul 2022 14:00:29 +0000 (GMT) X-Original-To: gcc-patches@gcc.gnu.org Delivered-To: gcc-patches@gcc.gnu.org Received: from smtp-out2.suse.de (smtp-out2.suse.de [IPv6:2001:67c:2178:6::1d]) by sourceware.org (Postfix) with ESMTPS id EEDFC3857C4E for <gcc-patches@gcc.gnu.org>; Mon, 25 Jul 2022 14:00:04 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org EEDFC3857C4E Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=suse.cz Authentication-Results: sourceware.org; spf=fail smtp.mailfrom=suse.cz Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by smtp-out2.suse.de (Postfix) with ESMTPS id E174E1FA32; Mon, 25 Jul 2022 14:00:02 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_rsa; t=1658757602; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=bu3M5eKyYZbGOp87AU8OMfwUpudhWTolLRwEL6PfLKY=; b=rrhnYtLcjt0GJUBGvYMybbBZ5+Psov4rGBsCHgv9KPbmqlLXIKFXDN5BnjlIiPUPcs1onQ lSI/AzScXnlB69B3e5t36QKQhrYZdcrw1ToeZHaMjvko/zblOohuF7QBcnI23Cy9FlMNRq SbIePhys9H9x/BPKyJJ+DBC3fppulj8= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_ed25519; t=1658757602; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=bu3M5eKyYZbGOp87AU8OMfwUpudhWTolLRwEL6PfLKY=; b=fC+zXySAddA/cp1OA89TWYdzjT2kZOxxKHYwekZkpZxlL7UBx1lPNGSIAng4GqElFhnMad eX8Y4+mYY4zw4JAA== Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by imap2.suse-dmz.suse.de (Postfix) with ESMTPS id CA7EF13A8D; Mon, 25 Jul 2022 14:00:02 +0000 (UTC) Received: from dovecot-director2.suse.de ([192.168.254.65]) by imap2.suse-dmz.suse.de with ESMTPSA id XcqJL+Kh3mJfCwAAMHmgww (envelope-from <mliska@suse.cz>); Mon, 25 Jul 2022 14:00:02 +0000 Message-ID: <7e41c1dd-d95a-0769-bfb5-c3713da240ab@suse.cz> Date: Mon, 25 Jul 2022 16:00:02 +0200 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.11.0 From: =?utf-8?q?Martin_Li=C5=A1ka?= <mliska@suse.cz> Subject: [PATCH] contrib: use sphinx-build from a venv To: gcc-patches@gcc.gnu.org Content-Language: en-US Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-Spam-Status: No, score=-11.7 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, SPF_HELO_NONE, SPF_SOFTFAIL, TXREP autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gcc-patches@gcc.gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gcc-patches mailing list <gcc-patches.gcc.gnu.org> List-Unsubscribe: <https://gcc.gnu.org/mailman/options/gcc-patches>, <mailto:gcc-patches-request@gcc.gnu.org?subject=unsubscribe> List-Archive: <https://gcc.gnu.org/pipermail/gcc-patches/> List-Post: <mailto:gcc-patches@gcc.gnu.org> List-Help: <mailto:gcc-patches-request@gcc.gnu.org?subject=help> List-Subscribe: <https://gcc.gnu.org/mailman/listinfo/gcc-patches>, <mailto:gcc-patches-request@gcc.gnu.org?subject=subscribe> Cc: Jonathan Wakely <jwakely.gcc@gmail.com> Errors-To: gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org Sender: "Gcc-patches" <gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org> X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1739333444396278288?= X-GMAIL-MSGID: =?utf-8?q?1739333444396278288?= |
Series |
contrib: use sphinx-build from a venv
|
|
Commit Message
Martin Liška
July 25, 2022, 2 p.m. UTC
Hi. As you likely know, I'm still working on transition of the current docs to Sphinx. But for now, I've sent a modernizing patches for the current libgccjit documentation and I will need a more recent version of Sphinx. Can please a maintainer install the package from pip? Something like: virtualenv /home/gcc/venv && /home/gcc/venv/bin/pip install Sphinx or a similar location? Thanks, Martin maintainer-scripts/ChangeLog: * update_web_docs_git: Use sphinx-build from a venv so that we can use a recent version. --- maintainer-scripts/update_web_docs_git | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-)
Comments
CCing overseers and Frank. Can you please help me with that? Thanks, Martin On 7/25/22 16:00, Martin Liška wrote: > Hi. > > As you likely know, I'm still working on transition of the current docs to Sphinx. > But for now, I've sent a modernizing patches for the current libgccjit documentation > and I will need a more recent version of Sphinx. > > Can please a maintainer install the package from pip? > > Something like: > virtualenv /home/gcc/venv && /home/gcc/venv/bin/pip install Sphinx > > or a similar location? > > Thanks, > Martin > > maintainer-scripts/ChangeLog: > > * update_web_docs_git: Use sphinx-build from a venv so that > we can use a recent version. > --- > maintainer-scripts/update_web_docs_git | 21 ++++++--------------- > 1 file changed, 6 insertions(+), 15 deletions(-) > > diff --git a/maintainer-scripts/update_web_docs_git b/maintainer-scripts/update_web_docs_git > index 996d29bfb68..4b01b3dc1c0 100755 > --- a/maintainer-scripts/update_web_docs_git > +++ b/maintainer-scripts/update_web_docs_git > @@ -176,23 +176,14 @@ for file in $MANUALS; do > fi > done > > -# The jit is a special-case, using sphinx rather than texinfo. > -# Specifically, the jit docs need sphinx 1.0 or later. > +# The jit is a special-case, using Sphinx rather than texinfo. > +# Specifically, the jit docs need Sphinx 3.0 or later. > # > -# The jit/docs Makefile uses the executable $(SPHINXBUILD), > -# defaulting to "sphinx-build". > -# > -# sphinx is packaged in Fedora and EPEL 6 within "python-sphinx", > -# in RHEL 8 within "python3-sphinx", > -# and in openSUSE within "python-Sphinx". > -# > -# For EPEL6, python-sphinx is sphinx 0.6.6, which is missing various > -# directives (e.g. ":c:macro:"), so we need the variant > -# python-sphinx10 package. The latter installs its executable as > -# /usr/bin/sphinx-1.0-build > -# so we needed to override SPHINXBUILD with this when invoking "make". > +# Use the Sphinx installed in a virtual environment so that > +# we don't depend on a system package. > + > pushd gcc/gcc/jit/docs > -make html || true > +make html SPHINXBUILD=/home/gcc/venv/bin/sphinx-build || true > popd > cp -a gcc/gcc/jit/docs/_build/html jit > mkdir -p $DOCSDIR/jit
Hi - > CCing overseers and Frank. > Can you please help me with that? > > Can please a maintainer install the package from pip? > > Something like: > > virtualenv /home/gcc/venv && /home/gcc/venv/bin/pip install Sphinx > > or a similar location? The gccadmin team can do this kind of thing without overseer/root privileges, or indeed so can any local shell-privileged user. (That said, rhel8 includes sphynx 1.7.6 - are you sure that's not satisfactory?) - FChE
On Tue, 26 Jul 2022 at 12:45, Frank Ch. Eigler <fche@redhat.com> wrote: > > Hi - > > > CCing overseers and Frank. > > Can you please help me with that? > > > > Can please a maintainer install the package from pip? > > > Something like: > > > virtualenv /home/gcc/venv && /home/gcc/venv/bin/pip install Sphinx > > > or a similar location? > > The gccadmin team can do this kind of thing without overseer/root > privileges, or indeed so can any local shell-privileged user. Yeah, I said I didn't want to install it that way without overseer approval, as pip won't keep the packages up to date the way dnf installations do. > (That said, rhel8 includes sphynx 1.7.6 - are you sure that's > not satisfactory?) That's a different package (full text search engine), what's needed here is python3-sphinx.
Hi - > > The gccadmin team can do this kind of thing without overseer/root > > privileges, or indeed so can any local shell-privileged user. > > Yeah, I said I didn't want to install it that way without overseer > approval, as pip won't keep the packages up to date the way dnf > installations do. Indeed, but that's your own preference/responsibility and does not affect the system, so no overseer oversight is necessary. > > (That said, rhel8 includes sphynx 1.7.6 - are you sure that's > > not satisfactory?) > > That's a different package (full text search engine), what's needed > here is python3-sphinx. # rpm -q python3-sphinx python3-sphinx-1.7.6-2.el8.noarch - FChE
On Tue, 26 Jul 2022 at 12:56, Frank Ch. Eigler wrote: > > Hi - > > > > The gccadmin team can do this kind of thing without overseer/root > > > privileges, or indeed so can any local shell-privileged user. > > > > Yeah, I said I didn't want to install it that way without overseer > > approval, as pip won't keep the packages up to date the way dnf > > installations do. > > Indeed, but that's your own preference/responsibility and does not > affect the system, so no overseer oversight is necessary. OK, I can install it for Martin then. > > > (That said, rhel8 includes sphynx 1.7.6 - are you sure that's > > > not satisfactory?) > > > > That's a different package (full text search engine), what's needed > > here is python3-sphinx. > > # rpm -q python3-sphinx > python3-sphinx-1.7.6-2.el8.noarch Oh right, yes, sorry, I got confused after I looked into the packages myself. The "other sphinx" is in EPEL 8 as sphinx-2.2.11-15.el8
On 7/26/22 14:01, Jonathan Wakely via Gcc-patches wrote: > On Tue, 26 Jul 2022 at 12:56, Frank Ch. Eigler wrote: >> >> Hi - >> >>>> The gccadmin team can do this kind of thing without overseer/root >>>> privileges, or indeed so can any local shell-privileged user. >>> >>> Yeah, I said I didn't want to install it that way without overseer >>> approval, as pip won't keep the packages up to date the way dnf >>> installations do. >> >> Indeed, but that's your own preference/responsibility and does not >> affect the system, so no overseer oversight is necessary. > > OK, I can install it for Martin then. Thanks Jonathan. > >>>> (That said, rhel8 includes sphynx 1.7.6 - are you sure that's >>>> not satisfactory?) >>> >>> That's a different package (full text search engine), what's needed >>> here is python3-sphinx. >> >> # rpm -q python3-sphinx >> python3-sphinx-1.7.6-2.el8.noarch > > Oh right, yes, sorry, I got confused after I looked into the packages > myself. The "other sphinx" is in EPEL 8 as sphinx-2.2.11-15.el8 Sorry, but it's too old, we actually need a release that was released this week ;) (5.1.0). Thanks, Martin
diff --git a/maintainer-scripts/update_web_docs_git b/maintainer-scripts/update_web_docs_git index 996d29bfb68..4b01b3dc1c0 100755 --- a/maintainer-scripts/update_web_docs_git +++ b/maintainer-scripts/update_web_docs_git @@ -176,23 +176,14 @@ for file in $MANUALS; do fi done -# The jit is a special-case, using sphinx rather than texinfo. -# Specifically, the jit docs need sphinx 1.0 or later. +# The jit is a special-case, using Sphinx rather than texinfo. +# Specifically, the jit docs need Sphinx 3.0 or later. # -# The jit/docs Makefile uses the executable $(SPHINXBUILD), -# defaulting to "sphinx-build". -# -# sphinx is packaged in Fedora and EPEL 6 within "python-sphinx", -# in RHEL 8 within "python3-sphinx", -# and in openSUSE within "python-Sphinx". -# -# For EPEL6, python-sphinx is sphinx 0.6.6, which is missing various -# directives (e.g. ":c:macro:"), so we need the variant -# python-sphinx10 package. The latter installs its executable as -# /usr/bin/sphinx-1.0-build -# so we needed to override SPHINXBUILD with this when invoking "make". +# Use the Sphinx installed in a virtual environment so that +# we don't depend on a system package. + pushd gcc/gcc/jit/docs -make html || true +make html SPHINXBUILD=/home/gcc/venv/bin/sphinx-build || true popd cp -a gcc/gcc/jit/docs/_build/html jit mkdir -p $DOCSDIR/jit