Skip to content

Commit cc81c15

Browse files
committed
docs: Add information on labels
1 parent 7f5107e commit cc81c15

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

docs/usage/overview.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,29 @@ or a cover letter or the web URL to a patch or a series:
162162

163163
__ https://www.kernel.org/doc/html/latest/process/submitting-patches.html
164164

165+
Labels
166+
~~~~~~
167+
168+
Labels are a way to organize and prioritize submissions. You can apply labels
169+
to patches and cover letters to signify priority, category, or any other marker
170+
you wish.
171+
172+
Labels can be either global or tied to the project they are created in. Labels
173+
can have an optional description attached, which will provide a little insight
174+
into the purpose of the label. Labels are completely customizable and the
175+
labels available will vary by instance.
176+
177+
Labels are parsed out of the square brackets of the subject line.
178+
For example, subject line ``[RFC, main] Add tests`` may cause the patch to be
179+
labeled with ``RFC`` and ``main``, if such labels were created for the project
180+
or instance. Labels can be created in the admin panel.
181+
182+
.. note::
183+
184+
In order to refresh the list of labels for existing patches, for example
185+
after updating Patchwork or adding a new label in the admin panel,
186+
use the :ref:`command-relabel` management command.
187+
165188
Checks
166189
~~~~~~
167190

0 commit comments

Comments
 (0)