Stale documentation

[Jamie Landeg-Jones]

Hi. On my travels, I stumbled on 
http://www.pl.freebsd.org/doc/handbook/current-stable.html which is old and not 
in sync with the main FreeBSD site.

Also, https://www.freebsd.org/doc/handbook/consoles.html still mentions vesa 
stuff.

Cheers
___
freebsd-doc@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: Stale documentation

[Jamie Landeg-Jones]

"Julian H. Stacey"  wrote:

> Unfortunately doc@ is wrong place to report that, nothing will
> happen unless you (or someone) find who controls update for that
> country's servers.

 [ ... ]

Thanks Julian. I'll do that. Incidently, I emailed 'doc' not even
realising it was a list, as at the bottom of the page it says:

"For questions about this documentation, e-mail ."

Looking further, the site hasn't been updated in *10* years!

Cheers, Jamie

___
freebsd-doc@freebsd.org mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: docs/100196: man login.conf does explain not " unlimited"

[Jamie Landeg Jones]

The following reply was made to PR docs/100196; it has been noted by GNATS.

From: Jamie Landeg Jones 
To: bug-follo...@freebsd.org, wald...@gmx.de
Cc:  
Subject: Re: docs/100196: man login.conf does explain not "unlimited"
Date: Sun, 27 Oct 2013 09:03:38 +0800

 --047d7b62535ac2c17404e9ae8d6d
 Content-Type: text/plain; charset=ISO-8859-1
 
 I too noticed this, and googled 'login.conf unlimited infinity' to check if
 there was actually any subtle difference between the two. (Hence finding
 this PR)
 
 The default login.conf uses both forms.
 
 Cheers,
   Jamie
 
 --047d7b62535ac2c17404e9ae8d6d
 Content-Type: text/html; charset=ISO-8859-1
 Content-Transfer-Encoding: quoted-printable
 
 I too noticed this, and googled 'login.conf unlimited infinity' =
 to check if there was actually any subtle difference between the two. (Henc=
 e finding this PR)
 The default login.conf uses both forms.
 Cheers,
 =A0=A0=A0=A0=A0 Jamie
 
 --047d7b62535ac2c17404e9ae8d6d--
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

docs/184791: [patch] man page for 'diff3' references 'info diff' instead of 'info diff3'

[Jamie Landeg Jones]

>Number: 184791
>Category:   docs
>Synopsis:   [patch] man page for 'diff3' references 'info diff' instead of 
>'info diff3'
>Confidential:   no
>Severity:   non-critical
>Priority:   low
>Responsible:freebsd-doc
>State:  open
>Quarter:
>Keywords:   
>Date-Required:
>Class:  doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Mon Dec 16 06:30:00 UTC 2013
>Closed-Date:
>Last-Modified:
>Originator: Jamie Landeg Jones
>Release:FreeBSD 9.0-RELEASE-p3 amd64
>Organization:
>Environment:
System: FreeBSD catnip.dyslexicfish.net 9.0-RELEASE-p3 FreeBSD 9.0-RELEASE-p3 
#0: Tue Jun 12 02:52:29 UTC 2012 
r...@amd64-builder.daemonology.net:/usr/obj/usr/src/sys/GENERIC amd64



>Description:

Most obsessive/pedantic/picky PR of the year goes to me, with:

The man page for diff3(1) refers to 'info diff' instead of
'info diff3'


>How-To-Repeat:

% man diff3

Compare the similarity of the end of this page with the end of the
'man diff' page.

Both refer to 'info diff' for more information, but if you compare
the results of 'info diff' and 'info diff3' you'll clearly see that
the man page for diff3 should be referencing 'info diff3'.

>Fix:

Patch supplied.



--- diff3.1.patch begins here ---
--- /usr/src/contrib/diff/man/diff3.1.orig  2013-10-24 01:39:21.0 
+0100
+++ /usr/src/contrib/diff/man/diff3.1   2013-12-12 02:31:58.0 +
@@ -73,6 +73,6 @@
 .B diff3
 programs are properly installed at your site, the command
 .IP
-.B info diff
+.B info diff3
 .PP
 should give you access to the complete manual.
--- diff3.1.patch ends here ---


>Release-Note:
>Audit-Trail:
>Unformatted:
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: docs/184791: [patch] man page for 'diff3' references 'info diff' instead of 'info diff3'

[Jamie Landeg Jones]

> Agreed.  However, this is "contrib" software from an external source, 
> and we generally prefer to get them patched upstream to avoid having to 
> maintain local patches.  I think this is the project page:
> http://www.gnu.org/software/diffutils/
>
> It's not clear how they prefer to get bug reports, but maybe a post to 
> their mailing list would help.

A. Yeah. That makes sense. I'll persue that avenue. Sorry for the
unintentional 'spam'. Feel free to close the PR!

Cheers for the reply, Jamie

___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: docs/184791: [patch] man page for 'diff3' references 'info diff' instead of 'info diff3'

[Jamie Landeg Jones]

The following reply was made to PR docs/184791; it has been noted by GNATS.

From: Jamie Landeg Jones 
To: wbl...@wonkity.com, ja...@dyslexicfish.net
Cc: freebsd-gnats-sub...@freebsd.org, freebsd-doc@freebsd.org
Subject: Re: docs/184791: [patch] man page for 'diff3' references 'info diff'
 instead of 'info diff3'
Date: Tue, 17 Dec 2013 04:19:54 +

 > Agreed.  However, this is "contrib" software from an external source, 
 > and we generally prefer to get them patched upstream to avoid having to 
 > maintain local patches.  I think this is the project page:
 > http://www.gnu.org/software/diffutils/
 >
 > It's not clear how they prefer to get bug reports, but maybe a post to 
 > their mailing list would help.
 
 A. Yeah. That makes sense. I'll persue that avenue. Sorry for the
 unintentional 'spam'. Feel free to close the PR!
 
 Cheers for the reply, Jamie
 
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: docs/184791: [patch] man page for 'diff3' references 'info diff' instead of 'info diff3'

[Jamie Landeg Jones]

> > >The man page for diff3(1) refers to 'info diff' instead of
> > >'info diff3'

Thanks guys for your responses and help. I followed this up,
and it's been corrected in the latest version of diffutils.

How readily would Freebsd accept a port/merge/update of this?

cheers, Jamie

___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: docs/184791: [patch] man page for 'diff3' references 'info diff' instead of 'info diff3'

[Jamie Landeg Jones]

The following reply was made to PR docs/184791; it has been noted by GNATS.

From: Jamie Landeg Jones 
To: wbl...@wonkity.com, r...@ringlet.net
Cc: ja...@dyslexicfish.net, freebsd-gnats-sub...@freebsd.org,
freebsd-doc@FreeBSD.org
Subject: Re: docs/184791: [patch] man page for 'diff3' references 'info diff'
 instead of 'info diff3'
Date: Fri, 03 Jan 2014 15:25:44 +

 > > >The man page for diff3(1) refers to 'info diff' instead of
 > > >'info diff3'
 
 Thanks guys for your responses and help. I followed this up,
 and it's been corrected in the latest version of diffutils.
 
 How readily would Freebsd accept a port/merge/update of this?
 
 cheers, Jamie
 
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: docs/184791: [patch] man page for 'diff3' references 'info diff' instead of 'info diff3'

[Jamie Landeg Jones]

>
> Normally, it would come in when the local diffutils are updated to the 
> latest upstream version.  I don't know when that will be or who would 
> handle it.

Yeah, that's what I meant. I'd be willing to have a look at it myself
if I knew they were open to submissions!

Cheers,
Jamie

___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: docs/184791: [patch] man page for 'diff3' references 'info diff' instead of 'info diff3'

[Jamie Landeg Jones]

The following reply was made to PR docs/184791; it has been noted by GNATS.

From: Jamie Landeg Jones 
To: wbl...@wonkity.com, ja...@dyslexicfish.net
Cc: r...@ringlet.net, freebsd-gnats-sub...@freebsd.org,
freebsd-doc@FreeBSD.org
Subject: Re: docs/184791: [patch] man page for 'diff3' references 'info diff'
 instead of 'info diff3'
Date: Sun, 05 Jan 2014 22:28:15 +

 >
 > Normally, it would come in when the local diffutils are updated to the 
 > latest upstream version.  I don't know when that will be or who would 
 > handle it.
 
 Yeah, that's what I meant. I'd be willing to have a look at it myself
 if I knew they were open to submissions!
 
 Cheers,
 Jamie
 
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: docs/184791: [patch] man page for 'diff3' references 'info diff' instead of 'info diff3'

[Jamie Landeg Jones]

Warren Block  wrote:

> I looked a bit more.  We currently have a fairly old version of 
> diffutils, 2.8.7.  It's unlikely that newer versions will be imported 
> because they are GPL: https://wiki.freebsd.org/GPLinBase
>
> Instead, there is a project to import the OpenBSD versions:
> https://wiki.freebsd.org/SummerOfCode2012/JesseHagewood
> Current status is not clear.
>
> Given that, I don't see why we can't make interim changes to the GNU 
> versions present now.  (And I'm sorry I didn't look at that earlier.)

Ahhh ok. Better to always get fixes made upstream, but in this case,
as we are no longer tracking the stream, may as well make the change
until BSD diffs come into play!

Cheers for your help, and sorry that something so trivial has become
the biggest bikeshed ever.

For what it's worth, I'm now much clearer on the way we deal with contrib
code.

Cheers, Jamie

___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

docs/186608: typo in 'ctime(3) man page

[Jamie Landeg-Jones]

>Number: 186608
>Category:   docs
>Synopsis:   typo in 'ctime(3) man page
>Confidential:   no
>Severity:   non-critical
>Priority:   low
>Responsible:freebsd-doc
>State:  open
>Quarter:
>Keywords:   
>Date-Required:
>Class:  doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Feb 09 22:20:00 UTC 2014
>Closed-Date:
>Last-Modified:
>Originator: Jamie Landeg-Jones
>Release:FreeBSD 10.0-STABLE amd64
>Organization:
>Environment:
System: FreeBSD catnip.dyslexicfish.net 10.0-STABLE FreeBSD 10.0-STABLE #0: Wed 
Jan 22 09:10:20 GMT 2014 
r...@catflap.dyslexicfish.net:/usr/obj/usr/src/sys/CATFLAP amd64



>Description:

Another typo. This time in ctime.3 man page..  I realise this is in 'contrib' 
but there doesn't seem to be any info regarding who this is pulled from.

I hope I don't get the reputation for most anal contributor :-(

(Is a PR the best way to report something so insignificant? Seems like 
overkill... Gimme doc commit access!)

Anyway The word 'leaves' instead of 'leave' in the following line:

"-these functions leaves their result in an internal static object and return"

cheers, Jamie


>How-To-Repeat:

man 3 ctime


>Fix:

apply patch (!)



--- patch begins here ---
--- contrib/tzcode/stdtime/ctime.3.orig 2014-02-09 06:47:03.0 +
+++ contrib/tzcode/stdtime/ctime.3  2014-02-09 06:47:47.0 +
@@ -342,7 +342,7 @@
 and the
 .Fn \&_r
 variants of the other functions,
-these functions leaves their result in an internal static object and return
+these functions leave their result in an internal static object and return
 a pointer to that object.
 Subsequent calls to these
 function will modify the same object.
--- patch ends here ---


>Release-Note:
>Audit-Trail:
>Unformatted:
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: docs/186608: typo in 'ctime(3) man page

[Jamie Landeg-Jones]

Benjamin Kaduk  wrote:

> I think that the current ~upstream for the tzcode is supposed to be 
> https://github.com/eggert/tz/ , but I haven't checked particularly 
> recently.  (There was some excitement involving a legal action, etc., so 
> it had gone away and/or moved.)  That said, I don't see a BUGS section at 
> all in the newctime.3 in that repo, and I also don't see the erroneous 
> line you quote in the history of that repo, so ... I'm not sure what 
> happened.

Ahh. OK! Thanks.

> > I hope I don't get the reputation for most anal contributor :-(
>
> Definitely not!

ha! You haven't seen my other PR's :-)

> PR is fine, it gives us a place to look when we need to find things.

ok, thanks.

> Thanks for pointing it out.  I'll try to think about what the best route 
> to a fix is.

no rush. hee hee.

p.s. my next PRs (2 pending) are 'proper' bug fixes!

cheers, Jamie

___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: docs/186608: typo in 'ctime(3) man page

[Jamie Landeg-Jones]

The following reply was made to PR docs/186608; it has been noted by GNATS.

From: Jamie Landeg-Jones 
To: ja...@dyslexicfish.net, b...@freebsd.org
Cc: freebsd-gnats-sub...@freebsd.org, freebsd-doc@freebsd.org
Subject: Re: docs/186608: typo in 'ctime(3) man page
Date: Thu, 13 Feb 2014 09:16:13 +

 Benjamin Kaduk  wrote:
 
 > I think that the current ~upstream for the tzcode is supposed to be 
 > https://github.com/eggert/tz/ , but I haven't checked particularly 
 > recently.  (There was some excitement involving a legal action, etc., so 
 > it had gone away and/or moved.)  That said, I don't see a BUGS section at 
 > all in the newctime.3 in that repo, and I also don't see the erroneous 
 > line you quote in the history of that repo, so ... I'm not sure what 
 > happened.
 
 Ahh. OK! Thanks.
 
 > > I hope I don't get the reputation for most anal contributor :-(
 >
 > Definitely not!
 
 ha! You haven't seen my other PR's :-)
 
 > PR is fine, it gives us a place to look when we need to find things.
 
 ok, thanks.
 
 > Thanks for pointing it out.  I'll try to think about what the best route 
 > to a fix is.
 
 no rush. hee hee.
 
 p.s. my next PRs (2 pending) are 'proper' bug fixes!
 
 cheers, Jamie
 
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

docs/188043: man page for md5/sha1/sha256/sha412/rmd-160 cleanup

[Jamie Landeg-Jones]

>Number: 188043
>Category:   docs
>Synopsis:   man page for md5/sha1/sha256/sha412/rmd-160 cleanup
>Confidential:   no
>Severity:   non-critical
>Priority:   low
>Responsible:freebsd-doc
>State:  open
>Quarter:
>Keywords:   
>Date-Required:
>Class:  doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sat Mar 29 10:10:00 UTC 2014
>Closed-Date:
>Last-Modified:
>Originator: Jamie Landeg-Jones
>Release:FreeBSD 10.0-STABLE amd64
>Organization:
Dyslexic Fish
>Environment:
System: FreeBSD catnip.dyslexicfish.net 10.0-STABLE FreeBSD 10.0-STABLE #0: Wed 
Jan 22 09:10:20 GMT 2014 
r...@catflap.dyslexicfish.net:/usr/obj/usr/src/sys/CATFLAP amd64



>Description:

man page shows for -c option: "Compare files to this md5 string."

This is misleading - the string needs to be in the same format as the digest 
command being used.

I suggest something like:

"Compare the files message digest to this string."

Also, suggest updating the date relating to known exploits.

>How-To-Repeat:

man sha1
man sha256
man sha512
man rmd-160
>Fix:

Apply attached patch suggestion



--- patch-md5.1 begins here ---
--- md5.1.orig  2014-02-17 01:41:53.0 +
+++ md5.1   2014-03-29 09:35:16.0 +
@@ -63,12 +63,12 @@
 This also means that
 .Tn MD5
 should not be used as part of a cryptographic signature scheme.
-At the current time (2009-01-06) there is no publicly known method to
+At the current time (2014-03-28) there is no publicly known method to
 .Dq reverse
 MD5, i.e., to find an input given a hash value.
 .Pp
 .Tn SHA-1
-currently (2009-01-06) has no known collisions, but an attack has been
+currently (2014-03-28) has no known collisions, but an attack has been
 found which is faster than a brute-force search, placing the security of
 .Tn SHA-1
 in doubt.
@@ -83,7 +83,7 @@
 after the options are processed.
 .Bl -tag -width indent
 .It Fl c Ar string
-Compare files to this md5 string.
+Compare the files message digest to this string.
 (Note that this option is not yet useful if multiple files are specified.)
 .It Fl s Ar string
 Print a checksum of the given
--- patch-md5.1 ends here ---


>Release-Note:
>Audit-Trail:
>Unformatted:
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: make lint

[Jamie Landeg-Jones]

Graham Perrin  wrote:

>  
> suggests:
>
> make lint
>
> I tried it whilst at /usr/src and at /usr/doc
>
> In both cases,
>
> > make: don't know how to make lint. Stop
> > …
>
> What am I missing?

LINT files are no longer created. Someone needs to prod the doc. team.

>From /usr/src/UPDATING:

20200923:
LINT files are no longer generated. We now include the relevant NOTES
files. Note: This may cause conflicts with updating in some cases.
find sys -name LINT\* -delete
is suggested across this commit to remove the generated LINT files.

If you have tried to update with generated files there, the svn
command you want to un-auger the tree is
cd sys/amd64/conf
svn revert -R .
and then do the above find from the top level. Substitute 'amd64'
above with where the error message indicates a conflict.

Cheers, Jamie

Re: make lint

[Jamie Landeg-Jones]

> LINT files are no longer created. Someone needs to prod the doc. team.

Ooops, should have looked more closely at the email address I was replying to!

Re: Localized versions of freebsd.org outdated and linked to by google

[Jamie Landeg-Jones]

Michael Gmelin  wrote:

> What I noticed while getting to localized versions is that some of
> these pages are really outdated and/or broken, even those central to
> the project.

Tangentally related, in the past I got caught out by googling the
FreeBSD manpage for something, and the google hit went to the version
for Linux. This wasn't even for a port, but a specific Linix distro.

On the FreeBSD website, with the FreeBSD logo and the heading "FreeBSD
Manual Pages", I missed the small drop down box saying "Redhat", or whatever.

I can't remember the command/URL off hand, but here are some examples. The
command I looked up gave a result less obvious than these, but you get the
point:

https://man.freebsd.org/cgi/man.cgi?query=ionice&apropos=0&sektion=1&manpath=Ubuntu+24.04+noble&arch=default&format=html

https://man.freebsd.org/cgi/man.cgi?query=ls&apropos=0&sektion=1&manpath=SunOS+4.1.3&arch=default&format=html

I don't think that the man.freebsd.org site should hold man pages for other
operating systems, or discontinued FreeBSD versions.

At the very least, they should not have a FreeBSD banner, and/or be hosted on
a different URL and/or marked as non-indexable in search engines.

Cheers, Jamie

Re: Moving vinum to docs-archive

[Jamie Landeg-Jones]

Maxim Konovalov  wrote:

> I don't believe that any of our supported versions have vinum as it
> was removed a decade ago.  For those who want to run FreeBSD 10 or
> earlier we have a VCS for docs.

Ah, that's fine then. Sorry, I thought it had been removed in 15.0.

cheers, J

Re: Moving vinum to docs-archive

[Jamie Landeg-Jones]

Maxim Konovalov  wrote:

> I'd remove it completely.

I personally don't have a problem with that, but generally speaking,
shouldn't documentation reflect supported releases, not just the
latest release?

At the very least, I'd expect the page to mention deprecation and
link to the original document.

Otherwise, you could get someone who takes on a machine that runs
a version of FreeBSD still in support, who needs help with base
software, yet the best documentation isn't to be found on the
authorative site.

Cheers, Jamie