| Summary: | [patch] man page for 'diff3' references 'info diff' instead of 'info diff3' | ||||||
|---|---|---|---|---|---|---|---|
| Product: | Documentation | Reporter: | Jamie Landeg-Jones <jamie> | ||||
| Component: | Books & Articles | Assignee: | Warren Block <wblock> | ||||
| Status: | Closed FIXED | ||||||
| Severity: | Affects Only Me | ||||||
| Priority: | Normal | ||||||
| Version: | Latest | ||||||
| Hardware: | Any | ||||||
| OS: | Any | ||||||
| Attachments: |
|
||||||
|
Description
Jamie Landeg-Jones
2013-12-16 06:30:00 UTC
> 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'. 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. > 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. Ahhhh. 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 On Tue, 17 Dec 2013, Jamie Landeg Jones wrote: >> 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. > > Ahhhh. 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 It's not a problem, and thanks for making the effort to report it. If you find other problems with the documentation but aren't sure where to report them, the freebsd-doc mailing list at http://lists.freebsd.org/mailman/listinfo/freebsd-doc can help classify them. Thanks! State Changed From-To: open->closed Closed at submitter's request. On Mon, Dec 16, 2013 at 02:33:30PM -0700, Warren Block wrote: > >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'. > > 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. Just for the record, I believe that some GNU projects now use the debbugs installation at http://debbugs.gnu.org/ - and from a quick look at http://debbugs.gnu.org/Packages.html it seems that diffutils is indeed among them. G'luck, Peter -- Peter Pentchev roam@ringlet.net roam@FreeBSD.org p.penchev@storpool.com PGP key: http://people.FreeBSD.org/~roam/roam.key.asc Key fingerprint 2EE7 A7A5 17FC 124C F115 C354 651E EFB0 2527 DF13 The rest of this sentence is written in Thailand, on > > >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
On Fri, 3 Jan 2014, Jamie Landeg Jones wrote: >>>> 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? 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. >
> 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
Responsible Changed From-To: freebsd-doc->wblock Take. On Sun, 5 Jan 2014, Jamie Landeg Jones wrote: >> >> 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! 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.) I'll take this and commit it to -CURRENT, with an MFC planned to 10-STABLE and 9-STABLE. Author: wblock (doc committer) Date: Sun Jan 5 23:28:03 2014 New Revision: 260358 URL: http://svnweb.freebsd.org/changeset/base/260358 Log: Fix a cut and paste error. PR: docs/184791 Submitted by: Jamie Landeg Jones <jamie@dyslexicfish.net> MFC after: 3 days Modified: head/contrib/diff/man/diff3.1 Modified: head/contrib/diff/man/diff3.1 ============================================================================== --- head/contrib/diff/man/diff3.1 Sun Jan 5 23:13:18 2014 (r260357) +++ head/contrib/diff/man/diff3.1 Sun Jan 5 23:28:03 2014 (r260358) @@ -73,6 +73,6 @@ and .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. _______________________________________________ svn-src-all@freebsd.org mailing list http://lists.freebsd.org/mailman/listinfo/svn-src-all To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org" Warren Block <wblock@wonkity.com> 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 |