
<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<title></title>

</head>

<body>

<div name="messageReplySection">2022年9月10日 AM11:00 +0900、patchwork-request@lists.ozlabs.orgのメール:<br />

<blockquote type="cite" style="border-left-color: grey; border-left-width: thin; border-left-style: solid; margin: 5px 5px;padding-left: 10px;">Send Patchwork mailing list submissions to<br />

patchwork@lists.ozlabs.org<br />

<br />

To subscribe or unsubscribe via the World Wide Web, visit<br />

https://lists.ozlabs.org/listinfo/patchwork<br />

or, via email, send a message with subject or body 'help' to<br />

patchwork-request@lists.ozlabs.org<br />

<br />

You can reach the person managing the list at<br />

patchwork-owner@lists.ozlabs.org<br />

<br />

When replying, please edit your Subject line so it is more specific<br />

than "Re: Contents of Patchwork digest..."<br />

<br />

<br />

Today's Topics:<br />

<br />

1. [PATCH 2/2] docs: Add info on contributing docs (Stephen Finucane)<br />

2. [PATCH 1/2] docs: Add references to VSCode Patchwork plugin<br />

(Stephen Finucane)<br />

<br />

<br />

----------------------------------------------------------------------<br />

<br />

Message: 1<br />

Date: Fri, 9 Sep 2022 15:29:43 +0100<br />

From: Stephen Finucane <stephen@that.guru><br />

To: patchwork@lists.ozlabs.org<br />

Subject: [PATCH 2/2] docs: Add info on contributing docs<br />

Message-ID: <20220909142943.353228-2-stephen@that.guru><br />

<br />

Noticed while whipping up a patch to document the new VSCode extension.<br />

<br />

Signed-off-by: Stephen Finucane <stephen@that.guru><br />

---<br />

docs/development/contributing.rst | 40 +++++++++++++++++++++++++++++++<br />

1 file changed, 40 insertions(+)<br />

<br />

diff --git docs/development/contributing.rst docs/development/contributing.rst<br />

index 16b3740d..7bf5e1ca 100644<br />

--- docs/development/contributing.rst<br />

+++ docs/development/contributing.rst<br />

@@ -141,6 +141,43 @@ for more information.<br />

<release-notes>` using the ``api`` section.<br />

<br />

<br />

+Documentation<br />

+-------------<br />

+<br />

+All documentation files including release notes are authored in<br />

+`reStructuredText`_ (rST). This is similar Markdown but significantly more<br />

+powerful and with a slightly trickier syntax. `Sphinx`_ is used for building<br />

+the documentation tree and the built documentation is published on `Read the<br />

+Docs`_.<br />

+<br />

+The documentation tree is broadly broken down into five categories:<br />

+<br />

+`api`<br />

+ Documentation for the APIs.<br />

+<br />

+`deployment`<br />

+ Documentation for people that wish to deploy or maintain a Patchwork<br />

+ instance.<br />

+<br />

+`development`<br />

+ Documentation for people that wish to contribute to Patchwork itself.<br />

+<br />

+`releases`<br />

+ Release notes.<br />

+<br />

+`usage`<br />

+ Documentation for people that wish to use and interact with an existing<br />

+ Patchwork instance.<br />

+<br />

+When contributing documentation, consider where your new documents should live.<br />

+You should also ensure the documentation builds after your modifications. This<br />

+can be done using the ``docs`` *tox* target.<br />

+<br />

+.. code-block:: shell<br />

+<br />

+ $ tox -e docs<br />

+<br />

+<br />

Reporting Issues<br />

----------------<br />

<br />

@@ -186,5 +223,8 @@ Further information about the Patchwork mailing list is available can be found o<br />

.. _reno: https://docs.openstack.org/developer/reno/<br />

.. _QEMU guidelines: http://wiki.qemu.org/Contribute/SubmitAPatch<br />

.. _Django REST Framework documentation: http://www.django-rest-framework.org/api-guide/versioning/<br />

+.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html<br />

+.. _Sphinx: https://www.sphinx-doc.org/en/master/<br />

+.. _Read the Docs: https://readthedocs.org<br />

.. _GitHub issue tracker: https://github.com/getpatchwork/patchwork<br />

.. _lists.ozlabs.org: https://lists.ozlabs.org/listinfo/patchwork<br />

--<br />

2.37.3<br />

<br />

<br />

<br />

------------------------------<br />

<br />

Message: 2<br />

Date: Fri, 9 Sep 2022 15:29:42 +0100<br />

From: Stephen Finucane <stephen@that.guru><br />

To: patchwork@lists.ozlabs.org<br />

Cc: Stephen Finucane <stephen@that.guru>, Florent Revest<br />

<revest@chromium.org><br />

Subject: [PATCH 1/2] docs: Add references to VSCode Patchwork plugin<br />

Message-ID: <20220909142943.353228-1-stephen@that.guru><br />

<br />

Signed-off-by: Stephen Finucane <stephen@that.guru><br />

Cc: Florent Revest <revest@chromium.org><br />

---<br />

README.rst | 20 ++++++++++++++++++++<br />

docs/usage/clients.rst | 32 +++++++++++++++++++++++++++-----<br />

2 files changed, 47 insertions(+), 5 deletions(-)<br />

<br />

diff --git README.rst README.rst<br />

index 94ae431d..979801fb 100644<br />

--- README.rst<br />

+++ README.rst<br />

@@ -38,6 +38,26 @@ subsystems of the Linux kernel. Although Patchwork has been developed with the<br />

kernel workflow in mind, the aim is to be flexible enough to suit the majority<br />

of community projects.<br />

<br />

+Usage<br />

+-----<br />

+<br />

+Patchwork provides a web UI, a REST API, and a XML-RPC API (*deprecated*). You<br />

+can use the APIs to `build you own application`__ or you can use one the many<br />

+`existing clients`__.<br />

+<br />

+There are many existing Patchwork instances. Unless you're a larger project<br />

+that is already hosting many of its own resources, you may wish to request a<br />

+project on one of these instances.<br />

+<br />

+- patchwork.ozlabs.org<br />

+- patchwork.kernel.org<br />

+- patches.linaro.org<br />

+- patchwork.sourceware.org<br />

+- patchwork.open-mesh.org<br />

+<br />

+__ https://patchwork.readthedocs.io/en/latest/development/api/<br />

+__ https://patchwork.readthedocs.io/en/latest/usage/clients/<br />

+<br />

Requirements<br />

------------<br />

<br />

diff --git docs/usage/clients.rst docs/usage/clients.rst<br />

index 01dd62a2..47ddb3a1 100644<br />

--- docs/usage/clients.rst<br />

+++ docs/usage/clients.rst<br />

@@ -4,6 +4,13 @@ Clients<br />

A number of clients are available for interacting with Patchwork's various<br />

APIs.<br />

<br />

+.. note::<br />

+<br />

+ Got a client that you think might be useful to the broader community? Feel<br />

+ free to add it to this page by `submitting a patch`__.<br />

+<br />

+ __ https://patchwork.readthedocs.io/en/latest/development/contributing/<br />

+<br />

<br />

pwclient<br />

--------<br />

@@ -31,7 +38,7 @@ __ https://github.com/getpatchwork/pwclient/<br />

git-pw<br />

------<br />

<br />

-The :program:`git-pw` application can be used to integrate Git with Patchwork.<br />

+The :program:`git-pw` application can be used to integrate Patchwork with Git.<br />

The :program:`git-pw` application relies on the REST API and can be used to<br />

interact to list, download and apply series, bundles and individual patches.<br />

<br />

@@ -42,13 +49,28 @@ __ https://git-pw.readthedocs.io/<br />

__ https://github.com/getpatchwork/git-pw/<br />

<br />

<br />

+VSCode-Patchwork<br />

+----------------<br />

+<br />

+The *Patchwork* VSCode plugin can be used to integrate Patchwork with VSCode.<br />

+This plugin relies on the REST API and can be used to view both patches and<br />

+series and to apply them locally. You can also browse patches and series and<br />

+look at replies.<br />

+<br />

+More information on the *Patchwork* VSCode plugin can be found on the `VSCode<br />

+Marketplace`__ and the `GitHub repo`__.<br />

+<br />

+__ https://marketplace.visualstudio.com/items?itemName=florent-revest.patchwork<br />

+__ https://github.com/FlorentRevest/vscode-patchwork<br />

+<br />

+<br />

snowpatch<br />

---------<br />

<br />

-The :program:`snowpatch` application is a bridge between Patchwork and the<br />

-Jenkins continuous integration automation server. It monitors the REST API<br />

-for incoming patches, applies them on top of an existing git tree, triggers<br />

-appropriate builds and test suites, and reports the results back to Patchwork.<br />

+The *snowpatch* application is a bridge between Patchwork and the Jenkins<br />

+continuous integration automation server. It monitors the REST API for incoming<br />

+patches, applies them on top of an existing git tree, triggers appropriate<br />

+builds and test suites, and reports the results back to Patchwork.<br />

<br />

Find out more about :program:`snowpatch` at its `GitHub repo`__.<br />

<br />

--<br />

2.37.3<br />

<br />

<br />

<br />

------------------------------<br />

<br />

Subject: Digest Footer<br />

<br />

_______________________________________________<br />

Patchwork mailing list<br />

Patchwork@lists.ozlabs.org<br />

https://lists.ozlabs.org/listinfo/patchwork<br />

<br />

<br />

------------------------------<br />

<br />

End of Patchwork Digest, Vol 162, Issue 1<br />

*****************************************<br /></blockquote>

</div>

</body>

</html>