2022年9月10日 AM11:00 +0900、patchwork-requ...@lists.ozlabs.orgのメール: > Send Patchwork mailing list submissions to > patchwork@lists.ozlabs.org > > To subscribe or unsubscribe via the World Wide Web, visit > https://lists.ozlabs.org/listinfo/patchwork > or, via email, send a message with subject or body 'help' to > patchwork-requ...@lists.ozlabs.org > > You can reach the person managing the list at > patchwork-ow...@lists.ozlabs.org > > When replying, please edit your Subject line so it is more specific > than "Re: Contents of Patchwork digest..." > > > Today's Topics: > > 1. [PATCH 2/2] docs: Add info on contributing docs (Stephen Finucane) > 2. [PATCH 1/2] docs: Add references to VSCode Patchwork plugin > (Stephen Finucane) > > > ---------------------------------------------------------------------- > > Message: 1 > Date: Fri, 9 Sep 2022 15:29:43 +0100 > From: Stephen Finucane <step...@that.guru> > To: patchwork@lists.ozlabs.org > Subject: [PATCH 2/2] docs: Add info on contributing docs > Message-ID: <20220909142943.353228-2-step...@that.guru> > > Noticed while whipping up a patch to document the new VSCode extension. > > Signed-off-by: Stephen Finucane <step...@that.guru> > --- > docs/development/contributing.rst | 40 +++++++++++++++++++++++++++++++ > 1 file changed, 40 insertions(+) > > diff --git docs/development/contributing.rst docs/development/contributing.rst > index 16b3740d..7bf5e1ca 100644 > --- docs/development/contributing.rst > +++ docs/development/contributing.rst > @@ -141,6 +141,43 @@ for more information. > <release-notes>` using the ``api`` section. > > > +Documentation > +------------- > + > +All documentation files including release notes are authored in > +`reStructuredText`_ (rST). This is similar Markdown but significantly more > +powerful and with a slightly trickier syntax. `Sphinx`_ is used for building > +the documentation tree and the built documentation is published on `Read the > +Docs`_. > + > +The documentation tree is broadly broken down into five categories: > + > +`api` > + Documentation for the APIs. > + > +`deployment` > + Documentation for people that wish to deploy or maintain a Patchwork > + instance. > + > +`development` > + Documentation for people that wish to contribute to Patchwork itself. > + > +`releases` > + Release notes. > + > +`usage` > + Documentation for people that wish to use and interact with an existing > + Patchwork instance. > + > +When contributing documentation, consider where your new documents should > live. > +You should also ensure the documentation builds after your modifications. > This > +can be done using the ``docs`` *tox* target. > + > +.. code-block:: shell > + > + $ tox -e docs > + > + > Reporting Issues > ---------------- > > @@ -186,5 +223,8 @@ Further information about the Patchwork mailing list is > available can be found o > .. _reno: https://docs.openstack.org/developer/reno/ > .. _QEMU guidelines: http://wiki.qemu.org/Contribute/SubmitAPatch > .. _Django REST Framework documentation: > http://www.django-rest-framework.org/api-guide/versioning/ > +.. _reStructuredText: > https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html > +.. _Sphinx: https://www.sphinx-doc.org/en/master/ > +.. _Read the Docs: https://readthedocs.org > .. _GitHub issue tracker: https://github.com/getpatchwork/patchwork > .. _lists.ozlabs.org: https://lists.ozlabs.org/listinfo/patchwork > -- > 2.37.3 > > > > ------------------------------ > > Message: 2 > Date: Fri, 9 Sep 2022 15:29:42 +0100 > From: Stephen Finucane <step...@that.guru> > To: patchwork@lists.ozlabs.org > Cc: Stephen Finucane <step...@that.guru>, Florent Revest > <rev...@chromium.org> > Subject: [PATCH 1/2] docs: Add references to VSCode Patchwork plugin > Message-ID: <20220909142943.353228-1-step...@that.guru> > > Signed-off-by: Stephen Finucane <step...@that.guru> > Cc: Florent Revest <rev...@chromium.org> > --- > README.rst | 20 ++++++++++++++++++++ > docs/usage/clients.rst | 32 +++++++++++++++++++++++++++----- > 2 files changed, 47 insertions(+), 5 deletions(-) > > diff --git README.rst README.rst > index 94ae431d..979801fb 100644 > --- README.rst > +++ README.rst > @@ -38,6 +38,26 @@ subsystems of the Linux kernel. Although Patchwork has > been developed with the > kernel workflow in mind, the aim is to be flexible enough to suit the majority > of community projects. > > +Usage > +----- > + > +Patchwork provides a web UI, a REST API, and a XML-RPC API (*deprecated*). > You > +can use the APIs to `build you own application`__ or you can use one the many > +`existing clients`__. > + > +There are many existing Patchwork instances. Unless you're a larger project > +that is already hosting many of its own resources, you may wish to request a > +project on one of these instances. > + > +- patchwork.ozlabs.org > +- patchwork.kernel.org > +- patches.linaro.org > +- patchwork.sourceware.org > +- patchwork.open-mesh.org > + > +__ https://patchwork.readthedocs.io/en/latest/development/api/ > +__ https://patchwork.readthedocs.io/en/latest/usage/clients/ > + > Requirements > ------------ > > diff --git docs/usage/clients.rst docs/usage/clients.rst > index 01dd62a2..47ddb3a1 100644 > --- docs/usage/clients.rst > +++ docs/usage/clients.rst > @@ -4,6 +4,13 @@ Clients > A number of clients are available for interacting with Patchwork's various > APIs. > > +.. note:: > + > + Got a client that you think might be useful to the broader community? Feel > + free to add it to this page by `submitting a patch`__. > + > + __ https://patchwork.readthedocs.io/en/latest/development/contributing/ > + > > pwclient > -------- > @@ -31,7 +38,7 @@ __ https://github.com/getpatchwork/pwclient/ > git-pw > ------ > > -The :program:`git-pw` application can be used to integrate Git with > Patchwork. > +The :program:`git-pw` application can be used to integrate Patchwork with > Git. > The :program:`git-pw` application relies on the REST API and can be used to > interact to list, download and apply series, bundles and individual patches. > > @@ -42,13 +49,28 @@ __ https://git-pw.readthedocs.io/ > __ https://github.com/getpatchwork/git-pw/ > > > +VSCode-Patchwork > +---------------- > + > +The *Patchwork* VSCode plugin can be used to integrate Patchwork with VSCode. > +This plugin relies on the REST API and can be used to view both patches and > +series and to apply them locally. You can also browse patches and series and > +look at replies. > + > +More information on the *Patchwork* VSCode plugin can be found on the `VSCode > +Marketplace`__ and the `GitHub repo`__. > + > +__ > https://marketplace.visualstudio.com/items?itemName=florent-revest.patchwork > +__ https://github.com/FlorentRevest/vscode-patchwork > + > + > snowpatch > --------- > > -The :program:`snowpatch` application is a bridge between Patchwork and the > -Jenkins continuous integration automation server. It monitors the REST API > -for incoming patches, applies them on top of an existing git tree, triggers > -appropriate builds and test suites, and reports the results back to > Patchwork. > +The *snowpatch* application is a bridge between Patchwork and the Jenkins > +continuous integration automation server. It monitors the REST API for > incoming > +patches, applies them on top of an existing git tree, triggers appropriate > +builds and test suites, and reports the results back to Patchwork. > > Find out more about :program:`snowpatch` at its `GitHub repo`__. > > -- > 2.37.3 > > > > ------------------------------ > > Subject: Digest Footer > > _______________________________________________ > Patchwork mailing list > Patchwork@lists.ozlabs.org > https://lists.ozlabs.org/listinfo/patchwork > > > ------------------------------ > > End of Patchwork Digest, Vol 162, Issue 1 > *****************************************
_______________________________________________ Patchwork mailing list Patchwork@lists.ozlabs.org https://lists.ozlabs.org/listinfo/patchwork
