Page MenuHomeFreeBSD

Update porter's handbook for USES=xorg
ClosedPublic

Authored by zeising on Jun 23 2019, 9:15 PM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Mar 14, 4:37 AM
Unknown Object (File)
Jan 25 2024, 6:21 AM
Unknown Object (File)
Dec 24 2023, 7:28 AM
Unknown Object (File)
Dec 21 2023, 7:57 PM
Unknown Object (File)
Dec 20 2023, 1:42 AM
Unknown Object (File)
Nov 28 2023, 9:58 PM
Unknown Object (File)
Nov 10 2023, 2:16 PM
Unknown Object (File)
Nov 7 2023, 6:49 PM
Subscribers
None

Details

Summary

Update porters handbook for USES=xorg and USES=xorg-cat, currently WIP in https://reviews.freebsd.org/D20724 .

Diff Detail

Repository
rD FreeBSD doc repository - subversion
Lint
Lint Skipped
Unit
Tests Skipped
Build Status
Buildable 25253

Event Timeline

Could you also add documentation for USES=xorg-cat?

In D20732#448815, @mat wrote:

Could you also add documentation for USES=xorg-cat?

I purposefully omitted it, since it is supposed to be internal to xorg ports, not used by other ports, similar to qt-dist.mk.

In D20732#448815, @mat wrote:

Could you also add documentation for USES=xorg-cat?

I purposefully omitted it, since it is supposed to be internal to xorg ports, not used by other ports, similar to qt-dist.mk.

Mmmm, I do not understand, you mean I'll have to document it myself when the other review hits the tree? All USES have to be documented, otherwise, the only one who knows how it works is you, so, the bus factor is 1, and it is very bad.

In D20732#448839, @mat wrote:
In D20732#448815, @mat wrote:

Could you also add documentation for USES=xorg-cat?

I purposefully omitted it, since it is supposed to be internal to xorg ports, not used by other ports, similar to qt-dist.mk.

Mmmm, I do not understand, you mean I'll have to document it myself when the other review hits the tree? All USES have to be documented, otherwise, the only one who knows how it works is you, so, the bus factor is 1, and it is very bad.

I thought the porter's handbook was for external facing things, so to speak. xorg-cat is meant to be only for xorg ports (ports coming from freedesktop.org), and not for general consumption. I have no problem adding it to the handbook, but since other similar things, such as qt-dist.mk, wasn't documented, I thought this was the way to do it. the previous XORG_CAT isn't documented anywhere, as far as I can tell.

I thought the porter's handbook was for external facing things, so to speak. xorg-cat is meant to be only for xorg ports (ports coming from freedesktop.org), and not for general consumption. I have no problem adding it to the handbook, but since other similar things, such as qt-dist.mk, wasn't documented, I thought this was the way to do it. the previous XORG_CAT isn't documented anywhere, as far as I can tell.

The Porter's Handbook is for porters. The xorg ports are ports written and updated by porters, so it needs to be documented. The only things that are not in the Porter's Handbook and that are in the Committer's Guide's Ports section are procedures that only committers needs. qt-dist being undocumented is most probably an oversight.

zeising edited the summary of this revision. (Show Details)
zeising added a reviewer: bcr.

Update patch, add documentation for USES=xorg-cat as well.

en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
6555

That line should happen before USE_MYSQL.

en_US.ISO8859-1/books/porters-handbook/special/chapter.xml
1559

Probably needs to reword the title here.

1561

missing xorg here.

1591

Probably needs USES=xorg here.

en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml
3450

Put x.org in an <application> tag.

3762

Extra > at the end of the sentence.

3767–3768

Remove but.

zeising marked 7 inline comments as done.

Updates based on comments from @mat

This revision is now accepted and ready to land.Aug 13 2019, 12:49 PM
This revision was automatically updated to reflect the committed changes.