Re: man.openbsd.org links on FAQ pages should point to -release
On 2016/12/06 19:46, Adam Wolk wrote: > Diff follows. On a side note it would be nice to have a OpenBSD-release > shorthand on man.openbsd.org pointing to the latest release. That would help > avoid a similar diff churn after 6.1 gets released. It sounds like it should be simple, but there is a problem every release where things get confused in the time between base switching to a newer version number and the final release being made (same for the installer, PKG_PATH, fw_update). In the case of faq manpage links, I think it's saner to have a bit of work done by "anyone who can commit" rather than force the maintainer of the man.openbsd.org server do extra work at release time - and specifying the version explicitly in the faq links has an extra benefit: if somebody has saved the FAQ from an old release (or checked-out an old version from cvs) the manpage links then point to an appropriate version.
Re: man.openbsd.org links on FAQ pages should point to -release
On Tue, Dec 06, 2016 at 07:46:31PM +0100, Adam Wolk wrote: > Hi tech@ > > _gypcio on IRC reported that pkg_sign uses a -s signify flag that was renamed > in > -current to signify2. The entry in the FAQ showing that example also linked > to a > pkg_sign man page from -current which lead to the confusion. > > Here is a diff generated with: > perl -pi.bak -e > 's|man.openbsd.org/(?!OpenBSD-6.0)|man.openbsd.org/OpenBSD-6.0/|g' faq*.html > > that turns all links in faq*.html from untagged links resolving to -current to > explicit OpenBSD-6.0. I did not alter the ports & pf faq's, current & upgrade > guides. The regex skipps links already tagged with OpenBSD-6.0 but don't run > it > blindly as it doens't protect from explicitly tagged 3.5, 3.6 etc (I did not > hit > any in the faq*.html files). > > Diff follows. On a side note it would be nice to have a OpenBSD-release > shorthand on man.openbsd.org pointing to the latest release. That would help > avoid a similar diff churn after 6.1 gets released. > > Feedback? OK's? A smaller diff was committed for the specific reported problem. Pinging so people don't spend time going over a huge diff. the commit: https://marc.info/?l=openbsd-cvs=148105690111936=2 Regards Adam
Re: man.openbsd.org links on FAQ pages should point to -release
On Tue, Dec 06, 2016 at 08:01:12PM +0100, Adam Wolk wrote: > On a side note it would be nice to have a OpenBSD-release shorthand on > man.openbsd.org pointing to the latest release. That would help avoid > a similar diff churn after 6.1 gets released. Although I recognize my opinion does not carry any weight in this discussion, I would personally like to see two options added to man.openbsd.org. One would be to specify the latest release and the other would be to explicitly ask for -current. For example: http://man.openbsd.org/release/manpage This would select man pages from the latest release and links in the FAQ could use this format to select release rather than -current man pages. It would also be nice to have a similar option: http://man.openbsd.org/current/manpage This would allow selecting man pages from -current. My personal opinion is that going to a man page should default to the latest release but I can understand reasons for defaulting to -current as it currently is. Those of us who have been using OpenBSD for years are not likely to be reading the FAQ regularly like new users would be and those users will likely be confused if the syntax shown in a man page they click on is different than their release system. Those of us that are used to -current can always select that option in the dropdown menu. Bryan
Re: man.openbsd.org links on FAQ pages should point to -release
On Tue, Dec 06, 2016 at 07:46:31PM +0100, Adam Wolk wrote: > Hi tech@ > > _gypcio on IRC reported that pkg_sign uses a -s signify flag that was renamed > in > -current to signify2. The entry in the FAQ showing that example also linked > to a > pkg_sign man page from -current which lead to the confusion. > > Here is a diff generated with: > perl -pi.bak -e > 's|man.openbsd.org/(?!OpenBSD-6.0)|man.openbsd.org/OpenBSD-6.0/|g' faq*.html > > that turns all links in faq*.html from untagged links resolving to -current to > explicit OpenBSD-6.0. I did not alter the ports & pf faq's, current & upgrade > guides. The regex skipps links already tagged with OpenBSD-6.0 but don't run > it > blindly as it doens't protect from explicitly tagged 3.5, 3.6 etc (I did not > hit > any in the faq*.html files). > > Diff follows. On a side note it would be nice to have a OpenBSD-release > shorthand on man.openbsd.org pointing to the latest release. That would help > avoid a similar diff churn after 6.1 gets released. > > Feedback? OK's? I accidentally broke 2 explicit links against OpenBSD-current. One in faq4 and one in faq8 - if the faq is against release I think they should also be changed to OpenBSD-6.0.
man.openbsd.org links on FAQ pages should point to -release
Hi tech@ _gypcio on IRC reported that pkg_sign uses a -s signify flag that was renamed in -current to signify2. The entry in the FAQ showing that example also linked to a pkg_sign man page from -current which lead to the confusion. Here is a diff generated with: perl -pi.bak -e 's|man.openbsd.org/(?!OpenBSD-6.0)|man.openbsd.org/OpenBSD-6.0/|g' faq*.html that turns all links in faq*.html from untagged links resolving to -current to explicit OpenBSD-6.0. I did not alter the ports & pf faq's, current & upgrade guides. The regex skipps links already tagged with OpenBSD-6.0 but don't run it blindly as it doens't protect from explicitly tagged 3.5, 3.6 etc (I did not hit any in the faq*.html files). Diff follows. On a side note it would be nice to have a OpenBSD-release shorthand on man.openbsd.org pointing to the latest release. That would help avoid a similar diff churn after 6.1 gets released. Feedback? OK's? Index: faq1.html === RCS file: /cvs/www/faq/faq1.html,v retrieving revision 1.201 diff -u -p -r1.201 faq1.html --- faq1.html 24 Sep 2016 03:22:12 - 1.201 +++ faq1.html 6 Dec 2016 18:31:28 - @@ -311,7 +311,7 @@ Some of the more popular lists are: announce - Project announcements and errata notices. This is a low-volume list. bugs - Bugs received via - http://man.openbsd.org/sendbug;>sendbug(1) + http://man.openbsd.org/OpenBSD-6.0/sendbug;>sendbug(1) and discussion about them. misc - General user questions and answers. This is the most active list, and should be the "default" for most @@ -332,7 +332,7 @@ While it might be the first time you hav others on the mailing lists may have seen the same question several times in the last week, and may not appreciate seeing it again. If asking a question possibly related to hardware, always include a full -http://man.openbsd.org/dmesg;>dmesg(8). +http://man.openbsd.org/OpenBSD-6.0/dmesg;>dmesg(8). You can find several archives, other guidelines and more information on the @@ -351,30 +351,30 @@ The man pages are the authoritative sour Here is a list of some useful manual pages for new users: - http://man.openbsd.org/afterboot;>afterboot(8) + http://man.openbsd.org/OpenBSD-6.0/afterboot;>afterboot(8) - things to check after the first complete boot. - http://man.openbsd.org/help;>help(1) + http://man.openbsd.org/OpenBSD-6.0/help;>help(1) - help for new users and administrators. - http://man.openbsd.org/hier;>hier(7) + http://man.openbsd.org/OpenBSD-6.0/hier;>hier(7) - layout of filesystems. - http://man.openbsd.org/man;>man(1) + http://man.openbsd.org/OpenBSD-6.0/man;>man(1) - display the manual pages. - http://man.openbsd.org/adduser;>adduser(8) + http://man.openbsd.org/OpenBSD-6.0/adduser;>adduser(8) - add new users. - http://man.openbsd.org/reboot;>reboot(8), halt(8) and - http://man.openbsd.org/shutdown;>shutdown(8) + http://man.openbsd.org/OpenBSD-6.0/reboot;>reboot(8), halt(8) and + http://man.openbsd.org/OpenBSD-6.0/shutdown;>shutdown(8) - stop and restart the system. - http://man.openbsd.org/dmesg;>dmesg(8) + http://man.openbsd.org/OpenBSD-6.0/dmesg;>dmesg(8) - redisplay the kernel boot messages. - http://man.openbsd.org/doas;>doas(1) + http://man.openbsd.org/OpenBSD-6.0/doas;>doas(1) - don't log in as root, but run commands as root. - http://man.openbsd.org/tmux;>tmux(1) + http://man.openbsd.org/OpenBSD-6.0/tmux;>tmux(1) - terminal multiplexer. - http://man.openbsd.org/ifconfig;>ifconfig(8) + http://man.openbsd.org/OpenBSD-6.0/ifconfig;>ifconfig(8) - configure network interface parameters. - http://man.openbsd.org/login.conf;>login.conf(5) + http://man.openbsd.org/OpenBSD-6.0/login.conf;>login.conf(5) - format of the login class configuration file. - http://man.openbsd.org/sendbug;>sendbug(1) + http://man.openbsd.org/OpenBSD-6.0/sendbug;>sendbug(1) - report a bug you've found. @@ -440,10 +440,10 @@ Replace ps with pdf if What are info files? Some of the documentation for OpenBSD comes in the form of -http://man.openbsd.org/info;>info(1) files. +http://man.openbsd.org/OpenBSD-6.0/info;>info(1) files. This is an alternative form of documentation provided by GNU. For example, to view information about the GNU compiler, -http://man.openbsd.org/gcc;>gcc(1), type: +http://man.openbsd.org/OpenBSD-6.0/gcc;>gcc(1), type: $ info gcc @@ -453,7 +453,7 @@ After using info, you will really apprec How do I write my own manual page? -Consult http://man.openbsd.org/mdoc;>mdoc(7). +Consult http://man.openbsd.org/OpenBSD-6.0/mdoc;>mdoc(7). Reporting bugs @@ -495,14 +495,14 @@ See this pagehttp://man.openbsd.org/sendbug;>sendbug(1) to report +Please use http://man.openbsd.org/OpenBSD-6.0/sendbug;>sendbug(1) to report your problems whenever possible, otherwise please include at least the -http://man.openbsd.org/dmesg;>dmesg(8) output of your system.
