Page MenuHomeFreeBSD

Correct policy for new ports' summary standard format
ClosedPublic

Authored by crees on Feb 9 2020, 3:06 PM.

Details

Reviewers
koobs
mat
salvadore
ygy
Group Reviewers
docs
Summary

This patch fixes the policy for new ports' summary standard format on Bugzilla in such a way that it is consistent with what bugs triagers prefer.

Diff Detail

Repository
rD FreeBSD doc repository - subversion
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 29258
Build 27175: arc lint + arc unit

Event Timeline

crees requested changes to this revision.Feb 9 2020, 4:24 PM
crees added a subscriber: crees.

Do you have a rendered version? I think the diff is missing a bit.

en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml
413–419

We report?

This revision now requires changes to proceed.Feb 9 2020, 4:24 PM

Sorry, I was copying the diff from a bug report I created long time ago and I copied it wrong. Now it should be fixed.
If anyone wants to see the bug report, you can find it at
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=232816

By the way, on that PR the patch already got approved by koobs.

Docs approval granted. Not sure if Mat wants to comment as it's a bugs part.

Thanks!

When we know about Mat, please keep in mind that I have no commit bit, so someone else should commit the patch for me. Thanks.

crees edited reviewers, added: salvadore; removed: crees.

Ok, no worries, I'll commit when Mat approves.

en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml
415–419

What is this <span class="quote">?

418

"short description of the port" was just right, why complicate it with some obscure variable expansion.

en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml
418

Oh, do you mean the content of the COMMENT variable in the port?

If so, it would be preferrable to leave the "short description of the port" so that it is easy to understand, and maybe add a note saying something like:

To describe the port, the content of the <varname>COMMENT</varname> variable can be used.

There are a couple of tagging issues I'll fix before committing, yes.

I'll use your COMMENT example.

This matches your suggestions.

Let me know if you're happy to proceed.

I'll deal with whitespace separately.

Except for whitespace, this looks ok.

This revision is now accepted and ready to land.Feb 25 2020, 1:53 PM