It poses a maintenance burden, since much of the information is
duplicated in the src tree's README.md file. Readers who are interested
enough in learning about the structure of the src tree can download it,
or browse the README online. Have hier(7) just point them there instead.
PR: 261349
Discussed with: freebsd-arch@, freebsd-doc@ lists
Reviewed by: imp, emaste
MFC after: 1 month
Sponsored by: The FreeBSD Foundation
Differential Revision: https://reviews.freebsd.org/D37135
(cherry picked from commit f0e4e02110)
Document it in sys/README.md instead. Describe the purpose of LINT
config files as well.
Reviewed by: imp
MFC after: 1 month
Sponsored by: The FreeBSD Foundation
Differential Revision: https://reviews.freebsd.org/D37134
(cherry picked from commit 9e0dcd0ab2)
Add this primarily to document the sys/ subdirectories of the source tree.
This is a straight copy from the contents of hier(7). Improvements will
follow in other changes.
Reviewed by: imp, emaste
MFC after: 1 month
Sponsored by: The FreeBSD Foundation
Differential Revision: https://reviews.freebsd.org/D37132
(cherry picked from commit d1087fe843)
It answers a question that someone might have when faced with the source
tree for the first time, and improves discoverability of the platforms
page.
Reviewed by: emaste
MFC after: 1 week
Sponsored by: The FreeBSD Foundation
Differential Revision: https://reviews.freebsd.org/D37179
(cherry picked from commit c34ffd6c8b)
Update the style to one sentence per line, as is currently used in the FreeBSD
document project. Make the links to the handbook clickable.
(cherry picked from commit 2918e9fdb8)
(At this point in main we have just LGPL libdialog and dialog, and GPL
diff3, left in gnu/.)
Reported by: bapt
MFC after: 3 days
Sponsored by: The FreeBSD Foundation
(cherry picked from commit 266cbbfc65)
This reverts commit 601ac82194.
Seems that git cherry-pick mis-merges files for this software.
It associates files in completely unrelated sub-trees with same name
files from this package, e.g. README.md and .gitignore.
My attempt to fix the mis-merge was incomplete and wrong.
Therefore I'm reverting the commit that as a result of my failed
attempt at conflict resolution lead to README.md and .gitignore
in the top source directory to be deleted.
This mistake has been carried over to releng/13.0, which now
also lacks README.md and .gitignore in /usr/src.
I'll try to re-apply the failed commit over the next hours and to get
the fix merged to releng/13.0 with re approval.
Inform new users what GENERIC and NOTES are. These are useful for people
perusing the tree without a great deal of specific fbsd knowledge.
See discussion of r334073 for further motivation.
Requested by: jhb
Rework the README to make it a little easier for new users. This is the
first file many will see when persuing the FreeBSD source code so
- remove some of the text describes how to build. This is better covered
in the linked documentation.
- add a small blurb for what FreeBSD is. Some users might find this
document through features such as github search so they may not even
know what the project is
generally, gear this file for the new, accidental, or casual user rather
than towards someone seeking fuller documentation.
