Page MenuHomeFreeBSD
Differential D24208

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

Authored by vidar_karlsen.tech on Mar 28 2020, 1:47 PM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Nov 25, 5:21 PM
Unknown Object (File)
Sun, Nov 16, 6:48 AM
Unknown Object (File)
Thu, Nov 13, 2:03 AM
Unknown Object (File)
Thu, Nov 13, 2:00 AM
Unknown Object (File)
Thu, Nov 13, 1:59 AM
Unknown Object (File)
Thu, Nov 13, 1:59 AM
Unknown Object (File)
Thu, Nov 13, 1:47 AM
Unknown Object (File)
Fri, Nov 7, 1:06 AM
View All Files
Subscribers
carlavilla
fernape
pauamma_gundo.com

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

vidar_karlsen.tech created this revision.Mar 28 2020, 1:47 PM
Herald added a reviewer: mat. · View Herald TranscriptMar 28 2020, 1:47 PM
Harbormaster completed remote builds in B30147: Diff 69947.Mar 28 2020, 1:47 PM
pauamma_gundo.com added a subscriber: pauamma_gundo.com.Apr 1 2020, 10:45 PM
ygy added a reviewer: portmgr.Nov 25 2020, 11:29 AM
pauamma_gundo.com added a comment.Mar 26 2022, 8:09 PM

Can you update your patch for AsciiDoc? https://docs.freebsd.org/en/books/fdp-primer/overview/#overview-documentation-ecosystem is relevant to appropriateness.

pauamma_gundo.com added a comment.Jul 23 2022, 2:21 AM

Can you convert it to AsciiDoc? https://docs.freebsd.org/en/books/fdp-primer/asciidoctor-primer/ and https://docs.freebsd.org/en/books/fdp-primer/rosetta/, and I can help if needed.

vidar_karlsen.tech added a comment.Jul 23 2022, 2:40 PM
In D24208#814843, @pauamma wrote:

Can you convert it to AsciiDoc? https://docs.freebsd.org/en/books/fdp-primer/asciidoctor-primer/ and https://docs.freebsd.org/en/books/fdp-primer/rosetta/, and I can help if needed.

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 updated this revision to Diff 108730.Jul 29 2022, 8:56 PM
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 a subscriber: fernape.Aug 2 2022, 6:04 AM
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.

vidar_karlsen.tech updated this revision to Diff 108804.Aug 2 2022, 12:46 PM

Specify the separators (: vs /)

fernape accepted this revision.Aug 2 2022, 3:24 PM

LGTM

Thanks!

mat added inline comments.Aug 25 2022, 8:04 AM
documentation/content/en/books/porters-handbook/makefiles/_index.adoc
1469

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 updated this revision to Diff 109830.Aug 25 2022, 1:54 PM
vidar_karlsen.tech marked an inline comment as done.

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

vidar_karlsen.tech added a comment.Aug 25 2022, 2:57 PM

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

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

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.

pauamma_gundo.com accepted this revision.Aug 26 2022, 11:27 AM

LGTM minus that one nit.

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

One sentence per line.++

vidar_karlsen.tech updated this revision to Diff 109927.Aug 28 2022, 7:50 AM

Changed to one sentence per line.

vidar_karlsen.tech marked an inline comment as done.Aug 28 2022, 7:50 AM
pauamma_gundo.com accepted this revision.Aug 28 2022, 6:47 PM
carlavilla added a subscriber: carlavilla.Sep 1 2022, 6:46 PM

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

pauamma_gundo.com added a comment.Oct 21 2022, 8:26 PM

Can someone from portmgr review this for accuracy?

Revision Contents
Changeset List

PathSize
documentation/
content/
en/
books/
porters-handbook/
makefiles/
5 lines

Diff 108804

View Options

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

Loading...