Page MenuHomeFreeBSD

dev-handbook: update description of contrib software
ClosedPublic

Authored by mhorne on Oct 19 2023, 4:50 PM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Apr 30, 5:53 AM
Unknown Object (File)
Tue, Apr 30, 5:52 AM
Unknown Object (File)
Tue, Apr 30, 5:28 AM
Unknown Object (File)
Tue, Apr 30, 5:10 AM
Unknown Object (File)
Mon, Apr 29, 10:10 PM
Unknown Object (File)
Mar 4 2024, 7:57 AM
Unknown Object (File)
Mar 3 2024, 3:52 PM
Unknown Object (File)
Feb 10 2024, 3:29 AM
Subscribers

Details

Summary

The existing description reflects a time when the process for managing
contrib software was less standardized. Provide a brief description of
how we manage vendor branches, with some conventions.

Open questions:

  • Is this the best place to act as source of truth for this information (separate from the import instructions)?
  • What information that I have put here is most likely to become stale?
Test Plan

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

mhorne created this revision.
carlavilla added a subscriber: carlavilla.
carlavilla added inline comments.
documentation/content/en/books/developers-handbook/policies/_index.adoc
100–101

Use the filepath macro

This revision is now accepted and ready to land.Oct 19 2023, 5:03 PM
emaste added inline comments.
documentation/content/en/books/developers-handbook/policies/_index.adoc
98

Maybe make the link text "libarchive's FREEBSD-upgrade file"?

Is this the best place to act as source of truth for this information (separate from the import instructions)?

I'd like to revisit the developer's handbook and committer's guide. there is legitimately some information that is only applicable to committers with @freebsd.org accounts, but with the git transition there is a lot that's in the committer's guide that is relevant to all contributors. But that is a bigger effort than this specific change, and I don't off hand have an opinion on where this should go vis a vis import instructions.

documentation/content/en/books/developers-handbook/policies/_index.adoc
92

It appears this dates to

commit aacf62b851e073c48c39bbd479a44aa5990ff78c
Author: Nik Clayton <nik@FreeBSD.org>
Date:   Wed Apr 1 18:25:32 1998 +0000

    This is first step in the Handbook migration from the LinuxDoc DTD to
    the DocBook DTD. Details on how this was carried out are in the README
    file.

The removed statement hasn't really been true for a couple of decades. Thanks for addressing this.

Tweak link text, use filepath macro.

This revision now requires review to proceed.Oct 19 2023, 6:36 PM
This revision is now accepted and ready to land.Oct 19 2023, 6:40 PM

Is this the best place to act as source of truth for this information (separate from the import instructions)?

I'd like to revisit the developer's handbook and committer's guide. there is legitimately some information that is only applicable to committers with @freebsd.org accounts, but with the git transition there is a lot that's in the committer's guide that is relevant to all contributors. But that is a bigger effort than this specific change, and I don't off hand have an opinion on where this should go vis a vis import instructions.

Sounds good, it should stay here then.

I have a lot of thoughts about the Developer's Handbook, and its somewhat confused purpose in the larger scheme of documentation. I intend to approach the freebsd-doc list about this in the near future. I think this is definitely in line with identifying overlap with the committers guide.

documentation/content/en/books/developers-handbook/policies/_index.adoc
100–101

Thanks for teaching me about this. FYI it does not appear to render any differently than regular text.

No pointer to the vendor import process?
Otherwise I like the changes with one nit.

documentation/content/en/books/developers-handbook/policies/_index.adoc
90

I'd do less or awk instead of patch. Patch doesn't really have an upstream, though openbsd often has good bits to pull in

In D42302#965311, @imp wrote:

No pointer to the vendor import process?

This is in the section right below, addressed by the other diff.

documentation/content/en/books/developers-handbook/policies/_index.adoc
90

Great suggestion, I will change it to awk before committing.