search

besser82 / libxcrypt

Extended crypt library for descrypt, md5crypt, bcrypt, and others
GNU Lesser General Public License v2.1
178 stars 49 forks source link

manpage .Os name: time to replace "Openwall Project" with something else? #184

Open Artoria2e5 opened 3 months ago

Artoria2e5 commented 3 months ago

libxcrypt currently says "Openwall Project" in the footer, even though (as far as I can tell) it's not really maintained or assembled together into a crypt.3 implementation by the Openwall people. https://github.com/besser82/libxcrypt/blob/72f75aa370ae96ccd2cc44ea3cf4182d8679ffbe/doc/crypt.3#L18

I do see that the man page is derived from openwall crypt_rn.3. I guess nobody just bothered to change it, not even during the mdoc conversion?

zackw commented 3 months ago

I preserved that on purpose during the mdoc conversion, to honor this project's origins in the Openwall Project. However, it might make sense to change it to "libxcrypt", as that would more clearly document the current origin of the manpage. @solardiz do you have an opinion?

solardiz commented 3 months ago

As it happens, I'm actually preparing a pull request with some edits to the man pages, prompted by the "bug" report here: https://www.openwall.com/lists/yescrypt/2024/03/21/1 I also saw this issue and also thought that I'm fine with either the mentions of Openwall Project staying as they are (as I had founded it and am also a bit involved here) or us switching to libxcrypt. Not having a clear preference, I didn't touch this in my edits so far.

Artoria2e5 commented 3 months ago

I am thinking that a lot of the information in AUTHORS can probably go into an expanded version of .Sh HISTORY or a new .Sh AUTHORS. Exactly how many words it would be, I don't know.

zackw commented 3 months ago

@solardiz

As it happens, I'm actually preparing a pull request with some edits to the man pages, prompted by the "bug" report here: https://www.openwall.com/lists/yescrypt/2024/03/21/1

I look forward to seeing it.

I'm fine with either the mentions of Openwall Project staying as they are (as I had founded it and am also a bit involved here) or us switching to libxcrypt

How about, as part of your PR, you change all these to

.Os "libxcrypt (Openwall Project)"

which preserves the credit but also indicates the current proximate source of the manpage.

solardiz commented 3 months ago

I'm actually preparing a pull request with some edits to the man pages

This is now #185. FWIW, I found the attribution to Openwall Project motivating for me to do the full proof-reading of crypt.5.

How about, as part of your PR, you change all these

I sent the PR maybe a minute before you posted this comment. But I can add a commit with that change if you and @besser82 want that - let me know.

zackw commented 3 months ago

@Artoria2e5 I don't think that information belongs in the crypt(3) manpage. It might be appropriate for crypt(5) but I see no particular harm in leaving it where it is -- anyone who cares about these details probably wants to look at the source anyway. What definitely would make sense is to add a URL for this github repo somewhere.

zackw commented 3 months ago

@solardiz Thanks. I will review that ... probably on Friday, given that I have several other major time commitments at the moment. It's up to you whether you want to add the .Os change; if you don't, I'll probably do it myself after giving @besser82 a week or so to comment.