Page MenuHomeFreeBSD

Remove trailing "@" from team approval example in Committer's Guide
ClosedPublic

Authored by pkelsey on Jul 19 2015, 8:50 PM.
Tags
None
Referenced Files
Unknown Object (File)
Fri, Mar 1, 2:58 AM
Unknown Object (File)
Jan 16 2024, 5:45 AM
Unknown Object (File)
Dec 22 2023, 10:39 PM
Unknown Object (File)
Nov 18 2023, 9:08 PM
Unknown Object (File)
Oct 30 2023, 11:43 AM
Unknown Object (File)
Sep 3 2023, 7:15 PM
Unknown Object (File)
May 23 2023, 11:26 PM
Unknown Object (File)
May 20 2023, 11:38 AM
Subscribers
None

Details

Summary

The use of a trailing "@" in team names in "Approved by:"
commit log lines is rare in the repos. Removing the trailing "@" in
the Committer's Guide example will also bring that example in line
with the advice given by the pre-commit hook when required approvals
are missing.

Diff Detail

Repository
rD FreeBSD doc repository - subversion
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

pkelsey retitled this revision from to Remove trailing "@" from team approval example in Committer's Guide.
pkelsey updated this object.
pkelsey edited the test plan for this revision. (Show Details)
pkelsey added reviewers: gjb, wblock.

Why in the world are there double backticks in that example and the one before it? It looks like a copy-paste from a man page.

We can certainly do better than that. How about a <screen> section with the correct usage of <literal> and <replaceable>?

  <para>If a team approved these commits, then include the
    team name followed by the username of the approver in
    parentheses.  For example:</para>

  <screen>Approved by: <userinput><literal>re</literal> (<replaceable>username</replaceable>)</userinput></screen>
</entry>
pkelsey edited edge metadata.

Adjusted markup for team approval example per wblock.

Nice! Sorry, the </entry> should be on the end of the </screen> line.

Could you to do the same thing for the previous paragraph? The text on that is currently pretty weak, so maybe:

<para>While under mentorship, get mentor approval before the commit.  Enter the mentor's username in this field, and note that they are a mentor:</para>

<screen>Approved by: <userinput><replaceable>username-of-mentor </replaceable> <literal>(mentor)</literal></userinput></screen></entry>

Moved </entry> to the end of the </screen> line in the last edit.

Incorporated additional suggested changes with some minor
modifications: removed extra space before </replaceable> and removed
</entry> from the end of the line as the entry ends after the
following paragraph.

wblock edited edge metadata.

Perfect! You even caught the bugs that were, um, included as a test. Yes, that's it, a test.

igor -R -C2492-2501 article.xml

Please adjust the indent on lines 2493 and 2494 one level inward (nega-clockwise, or "widdershins") and commit.

This revision is now accepted and ready to land.Jul 20 2015, 1:25 PM
This revision was automatically updated to reflect the committed changes.