diff mbox series

[2/3] docs: rSTify the "TrivialPatches" wiki

Message ID 20210922121054.1458051-3-kchamart@redhat.com (mailing list archive)
State New, archived
Headers show
Series rSTify SubmitAPatch, TrivialPatches, and SpellCheck wiki pages | expand

Commit Message

Kashyap Chamarthy Sept. 22, 2021, 12:10 p.m. UTC
The original wiki is here[1].  I converted by copying the wiki source
into a .wiki file and convert to rST using `pandoc`:

        $ pandoc -f Mediawiki -t rst trivial-patches.wiki -o trivial-patches.rst

[1] https://wiki.qemu.org/Contribute/TrivialPatches

Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
---
 docs/devel/trivial-patches.rst | 53 ++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 docs/devel/trivial-patches.rst

Comments

Philippe Mathieu-Daudé Sept. 22, 2021, 1:05 p.m. UTC | #1
Hi Kashyap,

On 9/22/21 14:10, Kashyap Chamarthy wrote:
> The original wiki is here[1].  I converted by copying the wiki source
> into a .wiki file and convert to rST using `pandoc`:
> 
>          $ pandoc -f Mediawiki -t rst trivial-patches.wiki -o trivial-patches.rst
> 
> [1] https://wiki.qemu.org/Contribute/TrivialPatches
> 
> Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
> ---
>   docs/devel/trivial-patches.rst | 53 ++++++++++++++++++++++++++++++++++
>   1 file changed, 53 insertions(+)
>   create mode 100644 docs/devel/trivial-patches.rst
> 
> diff --git a/docs/devel/trivial-patches.rst b/docs/devel/trivial-patches.rst
> new file mode 100644
> index 0000000000..4ad0d25b9d
> --- /dev/null
> +++ b/docs/devel/trivial-patches.rst
> @@ -0,0 +1,53 @@
> +===============
> +Trivial Patches
> +===============
> +
> +Overview
> +========
> +
> +Trivial patches that change just a few lines of code sometimes languish
> +on the mailing list even though they require only a small amount of
> +review. This is often the case for patches that do not fall under an
> +actively maintained subsystem and therefore fall through the cracks.
> +
> +The trivial patches team take on the task of reviewing and building pull
> +requests for patches that:
> +
> +- Do not fall under an actively maintained subsystem.
> +- Are single patches or short series (max 2-4 patches).
> +- Only touch a few lines of code.
> +
> +**You should hint that your patch is a candidate by CCing
> +qemu-trivial@nongnu.org.**
> +
> +Repositories
> +============
> +
> +Since the trivial patch team rotates maintainership there is only one
> +active repository at a time:
> +
> +- git://git.corpit.ru/qemu.git trivial-patches - `browse <http://git.corpit.ru/?p=qemu.git;a=shortlog;h=refs/heads/trivial-patches>`__
> +- git://github.com/vivier/qemu.git trivial-patches - `browse <https://github.com/vivier/qemu/tree/trivial-patches>`__
> +
> +Workflow
> +========
> +
> +The trivial patches team rotates the duty of collecting trivial patches
> +amongst its members. A team member's job is to:
> +
> +1. Identify trivial patches on the development mailing list.
> +2. Review trivial patches, merge them into a git tree, and reply to state
> +   that the patch is queued.
> +3. Send pull requests to the development mailing list once a week.
> +
> +A single team member can be on duty as long as they like. The suggested
> +time is 1 week before handing off to the next member.
> +
> +Team
> +====
> +
> +If you would like to join the trivial patches team, contact Michael
> +Tokarev. The current team includes:
> +
> +- Michael Tokarev
> +- `Laurent Vivier <mailto:laurent@vivier.eu>`__

I asked Michael if he could send a qemu-trivial@ pullreq last month
when Laurent was on PTO and he said he hasn't done it in years.

Indeed:

$ git log --committer='Michael Tokarev'
commit 9a232487aab8a7640ff8853d7d8d7c27106b44f8
Date:   Fri Apr 13 18:45:45 2018 +0200

So I think you are trying to commit obsolete information.

Anyway, up to Michael to adjust.

Thanks for rstifying the doc :)

Phil.
Kashyap Chamarthy Sept. 22, 2021, 1:16 p.m. UTC | #2
On Wed, Sep 22, 2021 at 03:05:02PM +0200, Philippe Mathieu-Daudé wrote:
> Hi Kashyap,

Heya,

> On 9/22/21 14:10, Kashyap Chamarthy wrote:

[...]

> > +If you would like to join the trivial patches team, contact Michael
> > +Tokarev. The current team includes:
> > +
> > +- Michael Tokarev
> > +- `Laurent Vivier <mailto:laurent@vivier.eu>`__
> 
> I asked Michael if he could send a qemu-trivial@ pullreq last month
> when Laurent was on PTO and he said he hasn't done it in years.
> 
> Indeed:
> 
> $ git log --committer='Michael Tokarev'
> commit 9a232487aab8a7640ff8853d7d8d7c27106b44f8
> Date:   Fri Apr 13 18:45:45 2018 +0200
> 
> So I think you are trying to commit obsolete information.
> 
> Anyway, up to Michael to adjust.
> 
> Thanks for rstifying the doc :)

Thanks for the quick review.  I first just did a 1-1 conversion of the
wiki, because I didn't want to mix content changes with the rST
conversion patch for various reasons we both know. :-)

If we don't hear from Michael on this, I'll let Peter/Laurent adjust the
doc while pushing the patch.
Daniel P. Berrangé Sept. 22, 2021, 1:18 p.m. UTC | #3
On Wed, Sep 22, 2021 at 03:05:02PM +0200, Philippe Mathieu-Daudé wrote:
> Hi Kashyap,
> 
> On 9/22/21 14:10, Kashyap Chamarthy wrote:
> > The original wiki is here[1].  I converted by copying the wiki source
> > into a .wiki file and convert to rST using `pandoc`:
> > 
> >          $ pandoc -f Mediawiki -t rst trivial-patches.wiki -o trivial-patches.rst
> > 
> > [1] https://wiki.qemu.org/Contribute/TrivialPatches
> > 
> > Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
> > ---
> >   docs/devel/trivial-patches.rst | 53 ++++++++++++++++++++++++++++++++++
> >   1 file changed, 53 insertions(+)
> >   create mode 100644 docs/devel/trivial-patches.rst
> > 
> > diff --git a/docs/devel/trivial-patches.rst b/docs/devel/trivial-patches.rst
> > new file mode 100644
> > index 0000000000..4ad0d25b9d
> > --- /dev/null
> > +++ b/docs/devel/trivial-patches.rst
> > @@ -0,0 +1,53 @@
> > +===============
> > +Trivial Patches
> > +===============
> > +
> > +Overview
> > +========
> > +
> > +Trivial patches that change just a few lines of code sometimes languish
> > +on the mailing list even though they require only a small amount of
> > +review. This is often the case for patches that do not fall under an
> > +actively maintained subsystem and therefore fall through the cracks.
> > +
> > +The trivial patches team take on the task of reviewing and building pull
> > +requests for patches that:
> > +
> > +- Do not fall under an actively maintained subsystem.
> > +- Are single patches or short series (max 2-4 patches).
> > +- Only touch a few lines of code.
> > +
> > +**You should hint that your patch is a candidate by CCing
> > +qemu-trivial@nongnu.org.**
> > +
> > +Repositories
> > +============
> > +
> > +Since the trivial patch team rotates maintainership there is only one
> > +active repository at a time:
> > +
> > +- git://git.corpit.ru/qemu.git trivial-patches - `browse <http://git.corpit.ru/?p=qemu.git;a=shortlog;h=refs/heads/trivial-patches>`__
> > +- git://github.com/vivier/qemu.git trivial-patches - `browse <https://github.com/vivier/qemu/tree/trivial-patches>`__
> > +
> > +Workflow
> > +========
> > +
> > +The trivial patches team rotates the duty of collecting trivial patches
> > +amongst its members. A team member's job is to:
> > +
> > +1. Identify trivial patches on the development mailing list.
> > +2. Review trivial patches, merge them into a git tree, and reply to state
> > +   that the patch is queued.
> > +3. Send pull requests to the development mailing list once a week.
> > +
> > +A single team member can be on duty as long as they like. The suggested
> > +time is 1 week before handing off to the next member.
> > +
> > +Team
> > +====
> > +
> > +If you would like to join the trivial patches team, contact Michael
> > +Tokarev. The current team includes:
> > +
> > +- Michael Tokarev
> > +- `Laurent Vivier <mailto:laurent@vivier.eu>`__
> 
> I asked Michael if he could send a qemu-trivial@ pullreq last month
> when Laurent was on PTO and he said he hasn't done it in years.
> 
> Indeed:
> 
> $ git log --committer='Michael Tokarev'
> commit 9a232487aab8a7640ff8853d7d8d7c27106b44f8
> Date:   Fri Apr 13 18:45:45 2018 +0200
> 
> So I think you are trying to commit obsolete information.

That's wikis for you.... pages of obsolete information. Bad info
is more likely to be noticed & updated if we have it in the qemu.git
repo where most developers work !


Regards,
Daniel
diff mbox series

Patch

diff --git a/docs/devel/trivial-patches.rst b/docs/devel/trivial-patches.rst
new file mode 100644
index 0000000000..4ad0d25b9d
--- /dev/null
+++ b/docs/devel/trivial-patches.rst
@@ -0,0 +1,53 @@ 
+===============
+Trivial Patches
+===============
+
+Overview
+========
+
+Trivial patches that change just a few lines of code sometimes languish
+on the mailing list even though they require only a small amount of
+review. This is often the case for patches that do not fall under an
+actively maintained subsystem and therefore fall through the cracks.
+
+The trivial patches team take on the task of reviewing and building pull
+requests for patches that:
+
+- Do not fall under an actively maintained subsystem.
+- Are single patches or short series (max 2-4 patches).
+- Only touch a few lines of code.
+
+**You should hint that your patch is a candidate by CCing
+qemu-trivial@nongnu.org.**
+
+Repositories
+============
+
+Since the trivial patch team rotates maintainership there is only one
+active repository at a time:
+
+- git://git.corpit.ru/qemu.git trivial-patches - `browse <http://git.corpit.ru/?p=qemu.git;a=shortlog;h=refs/heads/trivial-patches>`__
+- git://github.com/vivier/qemu.git trivial-patches - `browse <https://github.com/vivier/qemu/tree/trivial-patches>`__
+
+Workflow
+========
+
+The trivial patches team rotates the duty of collecting trivial patches
+amongst its members. A team member's job is to:
+
+1. Identify trivial patches on the development mailing list.
+2. Review trivial patches, merge them into a git tree, and reply to state
+   that the patch is queued.
+3. Send pull requests to the development mailing list once a week.
+
+A single team member can be on duty as long as they like. The suggested
+time is 1 week before handing off to the next member.
+
+Team
+====
+
+If you would like to join the trivial patches team, contact Michael
+Tokarev. The current team includes:
+
+- Michael Tokarev
+- `Laurent Vivier <mailto:laurent@vivier.eu>`__