Bug 267176

Summary:	articles/problem-reports: Remove 'add patch keyword' guideline
Product:	Documentation	Reporter:	Graham Perrin <grahamperrin>
Component:	Books & Articles	Assignee:	Graham Perrin <grahamperrin>
Status:	Closed FIXED
Severity:	Affects Some People	CC:	bugmeister
Priority:	---	Keywords:	easy
Version:	Latest
Hardware:	Any
OS:	Any
URL:	https://github.com/freebsd/freebsd-doc/blob/main/documentation/content/en/articles/problem-reports/_index.adoc
See Also:	https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=227147 https://reviews.freebsd.org/D37086

Description Graham Perrin freebsd_committer

2022-10-18 18:01:47 UTC

The article pleads for use of a keyword: 

    patch

<https://docs.freebsd.org/en/articles/problem-reports/#pr-writing-tips>: 

> … If you have a patch, say so. A PR with a patch included is much 
> more likely to be looked at than one without. Please set the 
> patch Keyword in Bugzilla. …


Deprecation was not discovered until after it was batch-added to a number of open bug reports, which had '[patch]' in the summary line but lacked the patch (or patch-ready) keyword. 

Corrections, to signify deprecation, have since been made to: 

    <https://bugs.freebsd.org/bugzilla/describekeywords.cgi>
    <https://wiki.freebsd.org/Bugzilla/Keywords>

Let's correct and update this article, beginning with the misdirection to use the patch keyword. 

See also: 

<https://wiki.freebsd.org/Bugzilla/DosAndDonts>

> …
> 
> Please, do not:
> 
> * use [TAGS] like [MAINTAINER], [UPDATE], [EXP-RUN] and [PATCH] 
>   in issue titles
> 
>   – [NEW PORT] in title for new port submissions is OK for now. 
> 
> …

<https://wiki.freebsd.org/Bugzilla/ThePerfectPortsIssue> 

<https://wiki.freebsd.org/KubilayKocak/Bugzilla/ProblemsAndIdeas> 

<https://wiki.freebsd.org/KubilayKocak/Bugzilla/Roadmap> 

…

Comment 1 Kubilay Kocak freebsd_committer

2022-10-18 22:32:47 UTC

@Graham +1 on removing a simple and now incorrect statement to ask for keywords, but let's focus on replacing the existing bug reporting guidelines wholesale, as it remains mostly vestigial from the GNATS days.

Can you add a patch here to remove the specific statement to add the patch keyword

Comment 2 Graham Perrin freebsd_committer

2022-10-19 00:13:58 UTC

(In reply to Kubilay Kocak from comment #1)

Thanks, what's GNATS?

Comment 3 Mark Linimon freebsd_committer

2022-10-21 02:11:13 UTC

(In reply to Graham Perrin from comment #2)

What FreeBSD used before switching to Bugzilla.  "You're right ... better not to know."

Comment 4 Graham Perrin freebsd_committer

2022-10-22 16:28:24 UTC

(In reply to Kubilay Kocak from comment #1)

Thanks. Diff in Phabricator, subject to review. 

I'll delete my bug-267176 branch <https://github.com/grahamperrin/freebsd-doc/tree/bug-267176> when this bug is closed.

Comment 5 commit-hook freebsd_committer

2022-10-29 03:31:29 UTC

A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=03d204adfdf1a7bb586db28e9e83e63ca683a3ad

commit 03d204adfdf1a7bb586db28e9e83e63ca683a3ad
Author:     Graham Perrin <grahamperrin@FreeBSD.org>
AuthorDate: 2022-10-29 03:16:34 +0000
Commit:     Graham Perrin <grahamperrin@FreeBSD.org>
CommitDate: 2022-10-29 03:16:34 +0000

    articles/problem-reports: cease recommending the 'patch' keyword

    'Writing FreeBSD Problem Reports' pleads for use of a keyword:

        patch

    – https://docs.freebsd.org/en/articles/problem-reports/#pr-writing-tips

    Keywords 'patch' and 'patch-ready' remain in Bugzilla –
    https://bugs.freebsd.org/bugzilla/describekeywords.cgi
    – but should no longer be used. Both keywords are deprecated:

    https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=227147

    Update the article:

    * end the plea
    * explain why the available keywords should not be used.

    PR:                                  267176
    Bug report: https://bugs.freebsd.org/267176
    Mentors:               gjb, carlavilla
    Reviewed by:           gjb
    Approved by:           gjb
    Differential revision: https://reviews.freebsd.org/D37086

 documentation/content/en/articles/problem-reports/_index.adoc | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comment 6 Graham Perrin freebsd_committer

2022-10-29 03:48:47 UTC

<https://codeberg.org/FreeBSD/freebsd-doc/commit/03d204adfdf1a7bb586db28e9e83e63ca683a3ad>

<https://gitlab.com/FreeBSD/freebsd-doc/-/commit/03d204adfdf1a7bb586db28e9e83e63ca683a3ad>

<https://github.com/freebsd/freebsd-doc/commit/03d204adfdf1a7bb586db28e9e83e63ca683a3ad>

<https://reviews.freebsd.org/R9:03d204adfdf1a7bb586db28e9e83e63ca683a3ad>


Re: comment #4

> I'll delete my bug-267176 branch 
> <https://github.com/grahamperrin/freebsd-doc/tree/bug-267176> 
> when this bug is closed.

Deleted.