Date: Sun, 17 Oct 1999 01:15:38 +0100 (BST) From: Andrew Boothman <andrew@ukug.uk.FreeBSD.org> To: Mark Ovens <mark@dogma.freebsd-uk.eu.org> Cc: FreeBSD-Doc@freebsd.org Subject: Re: Documentation index latest Message-ID: <XFMail.991017011538.andrew@ukug.uk.FreeBSD.org> In-Reply-To: <19991016215302.A320@marder-1>
next in thread | previous in thread | raw e-mail | index | archive | help
On 16-Oct-99 Mark Ovens wrote: > Good job Andrew! Thanks! > One thing I noticed is that ``@allfiles = readdir 'portsdir';'' in > docindex.pl seems to list the sub-dirs in creation order, not > alphabetical which would be better. Good point, I'll look into this. > I've knocked together the following wrapper script to build +DOCS > files for all the ports/packages installed on the system it's > running on. I've run it on mine and now I've got and index of all > the docs installed by ports/packages :) Excellent! How much tweaking did you find the DOCS files needed after they were created? I noticed that samba installs _lots_ of text files that the script thinks are documentation. Ultimately, I think the best person to tweak the DOCS file would be the maintainer of the port. You need to have access to the port's docs to make sure that the script has indexed them properly. And you need good knowledge of the port to know when some docs should be left out. Once we're sure about what we need them to do, this really needs to go to -docs, at least for commenting on if not actioning it. Your wrapper is still useful though, because it'll allow us to give the -ports crowd the largest possible head start, by letting us create a large number of DOCS file to begin with. I'm gonna fiddle with the docsmaker script a little more then, if no-one else has any other comments, I'll take it to -docs. BTW, would the people in -ports be willing to make the commits needed to add support for the index to /etc/periodic/daily and /etc/rc? Or should that go to -hackers or -current? --- Andrew Boothman <andrew@ukug.uk.FreeBSD.org> FreeBSD UK User Group http://ukug.uk.FreeBSD.org/~andrew/ http://ukug.uk.FreeBSD.org/ To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?XFMail.991017011538.andrew>