docs/159220: Strange sentence in /usr/src/UPDATING

[Benjamin Kaduk]

On Tue, 16 Aug 2011, Alexander Best wrote:

> On Tue Jul 26 11, Benjamin Kaduk wrote:
>> On Tue, 26 Jul 2011, Alexander Best wrote:
>>
>>> In /usr/src/UPDATING, almost at the very end of the file, there's the
>>> following sentence:
>>>
>>> "This file contains a list, in reverse chronological order, of major
>>> breakages in tracking -current.  Not all things will be listed here,
>>> and it only starts on October 16, 2004.  Updating files can found in
>>> previous releases if your system is older than this."
>>>
>>> The last sentence seems quite broken. At least I haven't got a clue what
>>> it's supposed to mean.
>>
>> "If you need to see entries from the UPDATING file which are older than
>> 2004/10/16, go get the UPDATING file from a previous &os; release, and it
>> will have a better chance of including what you're looking for."
>
> could we please please please get this fixed before 9.0?

I seem to recall there was discussion of this on IRC around the time it 
was sent in, though I don't have records of it handy.
Anyway, here, have a more suitable wording in the form of a patch.

-Ben Kaduk
-------------- next part --------------
--- UPDATING.orig	2011-08-18 23:49:35.000000000 -0400
+++ UPDATING	2011-08-18 23:52:31.000000000 -0400
@@ -1456,9 +1456,10 @@
 FORMAT:
 
 This file contains a list, in reverse chronological order, of major
-breakages in tracking -current.  Not all things will be listed here,
-and it only starts on October 16, 2004.  Updating files can found in
-previous releases if your system is older than this.
+breakages in tracking -current.  It is not guaranteed to be a complete
+list of such breakages, and only contains entries since October 16, 2004.
+If you need to see UPDATING entries from before that date, you will need
+to fetch an UPDATING file from an older FreeBSD release.
 
 Copyright information: