| Message ID | 20200220162214.3474280-1-eblake@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | maint: Include top-level *.rst files early in git diff | expand |
On Thu, Feb 20, 2020 at 10:22:13AM -0600, Eric Blake wrote: > We are converting more doc files to *.rst rather than *.texi. Most > doc files are already listed early in diffs due to our catchall > docs/*, but a few top-level files get missed by that glob. > > Signed-off-by: Eric Blake <eblake@redhat.com> > --- > > Both *.texi and *.rst entries make sense while we are still converting > things, but we'll need a followup to drop *.texi when the conversion > is complete... > > scripts/git.orderfile | 1 + > 1 file changed, 1 insertion(+) > > diff --git a/scripts/git.orderfile b/scripts/git.orderfile > index 1f747b583a9e..abd8a67a2b4e 100644 > --- a/scripts/git.orderfile > +++ b/scripts/git.orderfile > @@ -11,6 +11,7 @@ > > # Documentation > docs/* > +*.rst > *.texi > > # build system Reviewed-by: Stefano Garzarella <sgarzare@redhat.com>
On Thu, 20 Feb 2020 at 16:22, Eric Blake <eblake@redhat.com> wrote: > > We are converting more doc files to *.rst rather than *.texi. Most > doc files are already listed early in diffs due to our catchall > docs/*, but a few top-level files get missed by that glob. > > Signed-off-by: Eric Blake <eblake@redhat.com> > --- > > Both *.texi and *.rst entries make sense while we are still converting > things, but we'll need a followup to drop *.texi when the conversion > is complete... I was wondering what rst files we had outside docs, and the answer is "README.rst, CODING_STYLE.rst and tests/acceptance/README.rst". (There's a reasonable argument for moving CODING_STYLE.rst to docs/devel now; depends how highly you rate having it more "discoverable" to new contributors.) thanks -- PMM
On 2/21/20 4:17 AM, Peter Maydell wrote: > On Thu, 20 Feb 2020 at 16:22, Eric Blake <eblake@redhat.com> wrote: >> >> We are converting more doc files to *.rst rather than *.texi. Most >> doc files are already listed early in diffs due to our catchall >> docs/*, but a few top-level files get missed by that glob. >> >> Signed-off-by: Eric Blake <eblake@redhat.com> >> --- >> >> Both *.texi and *.rst entries make sense while we are still converting >> things, but we'll need a followup to drop *.texi when the conversion >> is complete... > > I was wondering what rst files we had outside docs, and > the answer is "README.rst, CODING_STYLE.rst and > tests/acceptance/README.rst". > > (There's a reasonable argument for moving CODING_STYLE.rst to > docs/devel now; depends how highly you rate having it more > "discoverable" to new contributors.) Or even: git mv CODING_STYLE.rst docs/devel/CODING_STYLE.rst ln -s docs/devel/CODING_STYLE.rst . git add CODING_STYLE.rst to turn it into a git link in the top level for easy discoverabilty on a fresh checkout, while still making it part of our overall built documentation.
Peter Maydell <peter.maydell@linaro.org> writes: > On Thu, 20 Feb 2020 at 16:22, Eric Blake <eblake@redhat.com> wrote: >> >> We are converting more doc files to *.rst rather than *.texi. Most >> doc files are already listed early in diffs due to our catchall >> docs/*, but a few top-level files get missed by that glob. >> >> Signed-off-by: Eric Blake <eblake@redhat.com> >> --- >> >> Both *.texi and *.rst entries make sense while we are still converting >> things, but we'll need a followup to drop *.texi when the conversion >> is complete... > > I was wondering what rst files we had outside docs, and > the answer is "README.rst, CODING_STYLE.rst and > tests/acceptance/README.rst". > > (There's a reasonable argument for moving CODING_STYLE.rst to > docs/devel now; depends how highly you rate having it more > "discoverable" to new contributors.) The little cynic in the back of my head cackles and points out that CODING_STYLE.rst exists not for new contributors to discover, but so that old contributors have something to smack on new heads. SCNR :)
Le 20/02/2020 à 17:22, Eric Blake a écrit : > We are converting more doc files to *.rst rather than *.texi. Most > doc files are already listed early in diffs due to our catchall > docs/*, but a few top-level files get missed by that glob. > > Signed-off-by: Eric Blake <eblake@redhat.com> > --- > > Both *.texi and *.rst entries make sense while we are still converting > things, but we'll need a followup to drop *.texi when the conversion > is complete... > > scripts/git.orderfile | 1 + > 1 file changed, 1 insertion(+) > > diff --git a/scripts/git.orderfile b/scripts/git.orderfile > index 1f747b583a9e..abd8a67a2b4e 100644 > --- a/scripts/git.orderfile > +++ b/scripts/git.orderfile > @@ -11,6 +11,7 @@ > > # Documentation > docs/* > +*.rst > *.texi > > # build system > Applied to my trivial-patches branch. Thanks, Laurent
diff --git a/scripts/git.orderfile b/scripts/git.orderfile index 1f747b583a9e..abd8a67a2b4e 100644 --- a/scripts/git.orderfile +++ b/scripts/git.orderfile @@ -11,6 +11,7 @@ # Documentation docs/* +*.rst *.texi # build system
We are converting more doc files to *.rst rather than *.texi. Most doc files are already listed early in diffs due to our catchall docs/*, but a few top-level files get missed by that glob. Signed-off-by: Eric Blake <eblake@redhat.com> --- Both *.texi and *.rst entries make sense while we are still converting things, but we'll need a followup to drop *.texi when the conversion is complete... scripts/git.orderfile | 1 + 1 file changed, 1 insertion(+)