Handbook update notifications

LoganGreystone

LoganGreystone

I read the handbook a year ago and see that every page has been updated since then, although in some cases they are minor changes. There is some basic and important information that I should read every time it is updated, but reading the entire handbook again for those changes is tiresome. For example, when portsnap was deprecated, the manual noted this and pointed out the new way to update the ports directory.
Is there any way to stay up to date with these updates and read the new sections or changes? I see that the page itself does not have an rss/feed, but the FreeBSD cgit has a doc branch where I think changes are marked. However, I have not found how to create cgit branch feeds. Do you use or have any other solution in mind?
 
Take a look at the commit log:

doc - FreeBSD documentation tree

cgit.freebsd.org cgit.freebsd.org
LoganGreystone said:
but the FreeBSD cgit has a doc branch
Click to expand...
That's not a 'branch', it's a repository. FreeBSD git servers hosts three repositories, src (for the FreeBSD sources), ports (for the FreeBSD ports tree) and doc (for the handbook).

LoganGreystone said:
However, I have not found how to create cgit branch feeds.
Click to expand...
Doc repository has no branches, there's only the main branch.
 
Unfortunately misc/freebsd-doc-en does not contain HTML versions of the handbook (anymore, cf. UPDATING). But you can still​
Bash: 
git clone https://git.FreeBSD.org/doc.git freebsd-doc
and​
Bash: 
# $_ expands to the last command’s last word (so freebsd-doc in this case)
cd $_ && \
	git diff --word-diff=color release/14.1.0 release/14.3.0 \
		'documentation/content/en/books/handbook/*[^p][^o]'
	# [^p][^o] to exclude GNU gettext portable object files
to review changes (you know, if the ASCIIDoc markup isn’t too scary for you).​
 
SirDice said:
Doc repository has no branches, there's only the main branch.
Click to expand...
Yes, I am unfamiliar with git terminology, and I mentioned it thinking that is what the repositories were called. Viewing the commit log is acceptable, but it includes many changes that are not part of the handbook like updates to the entire website.
sko said:
Such changes (e.g. deprecation of some tools) are listed in the release notes of each FreeBSD release and can be found here: https://www.freebsd.org/releases/
You should read those release notes before upgrading to a new version anyways - the handbook is meant to be a configuration guide and not to be used as an "indirect changelog".
Click to expand...
True, but in the deprecation of portsnap the release notes only explained the removal of the tool and told you to use git from then on, I had to look in the handbook for the change to know how to do it.
Kai Burghardt said:
(you know, if the ASCIIDoc markup isn’t too scary for you).​
Click to expand...
For now, it is the best option I can see, so I will do it that way.

Thanks to all three of you for the response (and I also appreciate the off-topic comment).
 
You must log in or register to reply here.
Back
Top