On 2/25/2010 3:53 PM, Chaz Chandler wrote: > >> >>> If there is consensus that using a man page would be inappropriate, >>> I am not opposed to generating a new document. Looking at the >>> contents of some /usr/doc/<project>/ directories, I often see >>> separate text only files for AUTHORS, CHANGELOG, COPYING or LICENSE, >>> INSTALL, NEWS, README, etc. We could certainly do the same or install >>> .html and .pdf versions of the documentation files which could include >>> the same contents. >> >> I have tools to convert a well-formatted text file to HTML that I use for >> all of my web pages, including handling of documents like this. I can get >> something like that working for OpenAFS as well. >> > > >>> We might also want to add a link to >> >>> https://www.ohloh.net/p/openafs/contributors >> >>> which generates a list from the Git repository contents.
The rationale for my statement was that by adding such a link to www.openafs.org/credits.html or to the documentation file that there would always be an up to date list based upon the current repository. > You can also get a list like this: > > git log --pretty=format:"%an" | sort | uniq This can certainly be used but one thing we have found is that there will be multiple entries for the same entity because the author names are based upon e-mail addresses. Many of our contributors have linked their e-mail addresses on ohloh.net and configured the preferred spellings of their names. > Where do we stand on this? READMEs, man pages? For starters I think we should use an AUTHORS or CREDITS file for Unix/Linux and on Windows the list will need to be incorporated into the release notes. Jeffrey Altman
smime.p7s
Description: S/MIME Cryptographic Signature
