| Message ID | 20210826171831.547578-3-stephen@that.guru |
|---|---|
| State | Accepted |
| Headers | show |
| Series | Make addressed/unaddressed workflow opt-in | expand |
LGTMed-by: Daniel Axtens <dja@axtens.net> I haven't looked at it quite enough to give it a proper Review but I don't have any obvious objections. Kind regards, Daniel Stephen Finucane <stephen@that.guru> writes: > Signed-off-by: Stephen Finucane <stephen@that.guru> > --- > docs/usage/overview.rst | 28 +++++++++++++++++++++++----- > 1 file changed, 23 insertions(+), 5 deletions(-) > > diff --git docs/usage/overview.rst docs/usage/overview.rst > index 273c792a..a58acfa5 100644 > --- docs/usage/overview.rst > +++ docs/usage/overview.rst > @@ -71,11 +71,11 @@ Cover Letters > ~~~~~~~~~~~~~ > > Cover letters provide a way to offer a "big picture" overview of a series of > -patches. When using Git, these mails can be recognised by way of their `0/N` > -subject prefix, e.g. `[00/11] A sample series`. Like patches, Patchwork stores > -not only the various aspects of the cover letter itself, such as the name and > -body of the cover letter, but also various metadata associated with the email > -that the cover letter was parsed from. > +patches. When using Git, these mails can be recognised by way of their ``0/N`` > +subject prefix, e.g. ``[00/11] A sample series``. Like patches, Patchwork > +stores not only the various aspects of the cover letter itself, such as the > +name and body of the cover letter, but also various metadata associated with > +the email that the cover letter was parsed from. > > > Comments > @@ -181,6 +181,24 @@ system to test patches. Checks have a number of fields associated with them: > to Patchwork. > > > +Comment Metadata > +---------------- > + > +Like patches, Patchwork allows users to store various bits of metadata against > +comments. > + > +Action required > +~~~~~~~~~~~~~~~ > + > +.. versionadded:: 3.1.0 > + > +Patchwork allows users to set an "action required" flag on patch and cover > +letter comments. This flag can be set by maintainers or by the users submitting > +the cover letters. Once the submitter has provided the required information, > +either the submitter or a maintainer can mark the comment as "addressed". This > +provides a more granular way of tracking work items than patch states. > + > + > Collections > ----------- > > -- > 2.31.1
diff --git docs/usage/overview.rst docs/usage/overview.rst index 273c792a..a58acfa5 100644 --- docs/usage/overview.rst +++ docs/usage/overview.rst @@ -71,11 +71,11 @@ Cover Letters ~~~~~~~~~~~~~ Cover letters provide a way to offer a "big picture" overview of a series of -patches. When using Git, these mails can be recognised by way of their `0/N` -subject prefix, e.g. `[00/11] A sample series`. Like patches, Patchwork stores -not only the various aspects of the cover letter itself, such as the name and -body of the cover letter, but also various metadata associated with the email -that the cover letter was parsed from. +patches. When using Git, these mails can be recognised by way of their ``0/N`` +subject prefix, e.g. ``[00/11] A sample series``. Like patches, Patchwork +stores not only the various aspects of the cover letter itself, such as the +name and body of the cover letter, but also various metadata associated with +the email that the cover letter was parsed from. Comments @@ -181,6 +181,24 @@ system to test patches. Checks have a number of fields associated with them: to Patchwork. +Comment Metadata +---------------- + +Like patches, Patchwork allows users to store various bits of metadata against +comments. + +Action required +~~~~~~~~~~~~~~~ + +.. versionadded:: 3.1.0 + +Patchwork allows users to set an "action required" flag on patch and cover +letter comments. This flag can be set by maintainers or by the users submitting +the cover letters. Once the submitter has provided the required information, +either the submitter or a maintainer can mark the comment as "addressed". This +provides a more granular way of tracking work items than patch states. + + Collections -----------
Signed-off-by: Stephen Finucane <stephen@that.guru> --- docs/usage/overview.rst | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-)