Page MenuHomeFreeBSD

Porter's handbook 5.4.3: clarify group in GH_TUPLE
Needs ReviewPublic

Authored by vidar_karlsen.tech on Mar 28 2020, 1:47 PM.
Tags
None
Referenced Files
Unknown Object (File)
Oct 3 2024, 5:33 AM
Unknown Object (File)
Oct 3 2024, 4:20 AM
Unknown Object (File)
Oct 2 2024, 7:09 PM
Unknown Object (File)
Oct 1 2024, 5:32 PM
Unknown Object (File)
Sep 26 2024, 9:17 PM
Unknown Object (File)
Sep 26 2024, 1:30 PM
Unknown Object (File)
Sep 24 2024, 9:15 AM
Unknown Object (File)
Sep 23 2024, 2:21 AM

Details

Reviewers
mat
fernape
pauamma_gundo.com
Group Reviewers
docs
portmgr
Summary

Porter's Handbook 5.4.3 USE_GITHUB describes the available variables,
but doesn't speak very clearly about GH_TUPLE's group parameter.

The group is only mentioned in the format, and the lack of : as a separator
between group and subdir is not mentioned at all.

This change clarifies the usage and syntax of the group parameter.

Test Plan

Build-tested and rendered in HTML ok.

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

In D24208#814843, @pauamma wrote:

I have put it on my todo list. The summer is a busy time so I can't make any promises as to when I will be able to get it done.

vidar_karlsen.tech edited the test plan for this revision. (Show Details)

Updated diff against the new AsciiDoc docs.

While here I noticed that the whole GH_TUPLE row had disappeared from table 5 due to a missing cell (line 1472 fixes that). Glitch in the conversion process?

fernape added inline comments.
documentation/content/en/books/porters-handbook/makefiles/_index.adoc
1471

Note that _group_ and _subdir_ ...

without the / that is actually the separator.

documentation/content/en/books/porters-handbook/makefiles/_index.adoc
1469–1474

Please, keep the previous

_account_`:`_project_`:`_tagname_`:`_group_`/`_subdir_

or if you prefer

`_account_:_project_:_tagname_:_group_/_subdir_`

It is more accurate, the : and / are not parts that need to be replaced.

vidar_karlsen.tech marked an inline comment as done.

Make the separator characters (: and /) stand out.

Looks like my inline comments were never submitted. Will this do the trick?

documentation/content/en/books/porters-handbook/makefiles/_index.adoc
1469–1474

None of those formats render correctly in the final HTML result.
The first (original) one comes out as

account`:`project`:`tagname`:`group`/subdir

and the alternative comes out as

`account:_project_:_tagname_:_group_/subdir

which is why I changed it in the first place. Both of the above outputs are pasted from the generated HTML.
Having twiddled a bit, it seems I can use double tics and have it render somewhat along the lines of how it should be.
This:

``_account_``:``_project_``:``_tagname_``:``_group_``/``_subdir_``

gets rendered without any control characters slipping through, and the separators do stand out.

1471

Thanks, fixed.

LGTM minus that one nit.

documentation/content/en/books/porters-handbook/makefiles/_index.adoc
1469–1474

One sentence per line.++

@mat from your side is everything ok? can we commit this?

Can someone from portmgr review this for accuracy?