Hi,

Andras Farkas wrote on Wed, Oct 21, 2020 at 09:19:43PM -0400:

> While reading 68.html I noticed some of the man page links pointed to
> the man pages in the wrong section of the manual. (at least, given the
> manual section numbers listed next to them in the 68.html text)
> I decided to fix these.

Thanks, i just committed these four fixes.

By the way, this is why i urge developers to get into the habit
of always writing manual page links in the form

  https://man.openbsd.org/name.section

The two additional keystrokes for the dot and the section number
won't wear out your fingertips, and experience shows that trying
to do it "only when needed" just doesn't work.  Practically everybody
(myself included) occasionally forgets a required number when trying
that, and a habit of checking every link would cause more work than
adding two bytes.

Besides, sometimes new pages appear later that cause a link to
change.  For example, we have editline(3) for a long time, and then
later on, editline(7) appeared, too.  At that point, a link to just
https://man.openbsd.org/editline would have changed target, even
for pages of *past* releases.

> While there, I also made the fixed links point at 6.8 man pages
> rather than -current man pages.

I didn't take these changes: sysctl(2), scsi(4), video(4), drm(4)
are not going away.

> This is important in case functionality mentioned in 68.html
> is changed or removed in a later version of OpenBSD.

No that isn't important, even if in rare cases, old links go dead.
In general, it is useful to have old release pages link to -current
documentation (because the reason for looking at old release
pages is often "when did this feature appear?", and then the new
manual page is more useful for users than an outdated version).
Besides, adding /OpenBSD-X.Y/ makes the links too long and ugly.

> I also turned two mentions of bettertls.com into hyperlinks.

Never send diffs mixing logically unrelated changes.

I committed that separately.

> Diff attached:
> SHA256 (68diff) =
> d16eb33d863866b004d75041e42c24100dd4200864a5b2243913f98ad5d8eaa9

Hashing diffs is useless.  The are scrutinized before commit anyway,
and what matters is whether they are correct, not whether they
contain what you intended.

More importantly, never send diffs as attachments; that's just a
waste of developer time.  Include them directly into the body of
the mail, ideally at the end.  And please don't waste more time
arguing that your mail client can't do that; in that case just get
a decent mail client *before* sending diffs.

> Also, some links on 68.html (like amlpwrc

Hopefully, somebody is going to document that driver eventually,
and then the link will come alive.

> and sftp-client)

That was just an error: sftp-client.c is the source file, but the
program and the manual page are called sftp(1).  Fixed.

[...]
> issues noticed by
> https://validator.w3.org/nu/

Done, too.

> There was also a mention of sshd(1) that should probably be ssh(1) but
> I wasn't sure.  Please check.

Right, that's sshconnect2.c rev. 1.322, order_hostkeyalgs(), called
from ssh_kex2(), called from ssh_login(), called from ssh.c main(),
which is the ssh(1) client, not sshd(8).  Fixed.

Yours,
  Ingo

Reply via email to