* [PATCH] maint: Include top-level *.rst files early in git diff
@ 2020-02-20 16:22 Eric Blake
2020-02-21 8:38 ` Stefano Garzarella
` (2 more replies)
0 siblings, 3 replies; 6+ messages in thread
From: Eric Blake @ 2020-02-20 16:22 UTC (permalink / raw)
To: qemu-devel; +Cc: qemu-trivial, peter.maydell
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
--
2.24.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH] maint: Include top-level *.rst files early in git diff
2020-02-20 16:22 [PATCH] maint: Include top-level *.rst files early in git diff Eric Blake
@ 2020-02-21 8:38 ` Stefano Garzarella
2020-02-21 10:17 ` Peter Maydell
2020-03-09 8:51 ` Laurent Vivier
2 siblings, 0 replies; 6+ messages in thread
From: Stefano Garzarella @ 2020-02-21 8:38 UTC (permalink / raw)
To: Eric Blake; +Cc: qemu-trivial, peter.maydell, qemu-devel
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>
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] maint: Include top-level *.rst files early in git diff
2020-02-20 16:22 [PATCH] maint: Include top-level *.rst files early in git diff Eric Blake
2020-02-21 8:38 ` Stefano Garzarella
@ 2020-02-21 10:17 ` Peter Maydell
2020-02-21 14:33 ` Eric Blake
2020-02-21 16:40 ` Markus Armbruster
2020-03-09 8:51 ` Laurent Vivier
2 siblings, 2 replies; 6+ messages in thread
From: Peter Maydell @ 2020-02-21 10:17 UTC (permalink / raw)
To: Eric Blake; +Cc: QEMU Trivial, QEMU Developers
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
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] maint: Include top-level *.rst files early in git diff
2020-02-21 10:17 ` Peter Maydell
@ 2020-02-21 14:33 ` Eric Blake
2020-02-21 16:40 ` Markus Armbruster
1 sibling, 0 replies; 6+ messages in thread
From: Eric Blake @ 2020-02-21 14:33 UTC (permalink / raw)
To: Peter Maydell; +Cc: QEMU Trivial, QEMU Developers
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.
--
Eric Blake, Principal Software Engineer
Red Hat, Inc. +1-919-301-3226
Virtualization: qemu.org | libvirt.org
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] maint: Include top-level *.rst files early in git diff
2020-02-21 10:17 ` Peter Maydell
2020-02-21 14:33 ` Eric Blake
@ 2020-02-21 16:40 ` Markus Armbruster
1 sibling, 0 replies; 6+ messages in thread
From: Markus Armbruster @ 2020-02-21 16:40 UTC (permalink / raw)
To: Peter Maydell; +Cc: QEMU Trivial, QEMU Developers
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 :)
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] maint: Include top-level *.rst files early in git diff
2020-02-20 16:22 [PATCH] maint: Include top-level *.rst files early in git diff Eric Blake
2020-02-21 8:38 ` Stefano Garzarella
2020-02-21 10:17 ` Peter Maydell
@ 2020-03-09 8:51 ` Laurent Vivier
2 siblings, 0 replies; 6+ messages in thread
From: Laurent Vivier @ 2020-03-09 8:51 UTC (permalink / raw)
To: Eric Blake, qemu-devel; +Cc: qemu-trivial, peter.maydell
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
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2020-03-09 8:52 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-02-20 16:22 [PATCH] maint: Include top-level *.rst files early in git diff Eric Blake
2020-02-21 8:38 ` Stefano Garzarella
2020-02-21 10:17 ` Peter Maydell
2020-02-21 14:33 ` Eric Blake
2020-02-21 16:40 ` Markus Armbruster
2020-03-09 8:51 ` Laurent Vivier
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 NNTP newsgroup(s).