On Tue, Jun 21, 2011 at 11:38:58AM -0500, Dan McGee wrote: > On Mon, Jun 20, 2011 at 6:08 PM, Dave Reisner <[email protected]> wrote: > > On Mon, Jun 20, 2011 at 06:30:29PM -0400, Eric Bélanger wrote: > >> On Mon, Jun 20, 2011 at 2:15 PM, Dave Reisner <[email protected]> wrote: > >> > Signed-off-by: Dave Reisner <[email protected]> > >> > --- > >> > This isn't documented anywhere except in the code, and every few months > >> > when I > >> > end up having to test something that requires my own repo, it takes me 10 > >> > minutes to figure out wtf a valid file extension is. > >> > > >> > d > >> > > >> > doc/repo-add.8.txt | 4 ++++ > >> > 1 files changed, 4 insertions(+), 0 deletions(-) > >> > > >> > diff --git a/doc/repo-add.8.txt b/doc/repo-add.8.txt > >> > index 0196882..c4f42a2 100644 > >> > --- a/doc/repo-add.8.txt > >> > +++ b/doc/repo-add.8.txt > >> > @@ -29,6 +29,10 @@ command line. > >> > delta specified on the command line. Multiple packages and/or delta to > >> > remove > >> > can be specified on the command line. > >> > > >> > +A package database is a path a compressed tar file with one of the > >> > extensions: > >> > +``.tar'', ``.tar.gz'', ``.tar.bz2'', or ``.tar.xz''. > >> > >> I am not a native English speaker but this sentence looks awkward. It > >> seems like a word (or verb?) is missing in the "a path a compressed > >> tar file" part. > >> > > > > A herp a derp. > > > > I'm missing a 'to', perhaps. A database is a path to a tar file... > > Should revise this to note that compression is optional (in addition to > > the .tar extension). > > The current text on your working branch and my comments: > > +A package database is a tar file, optionally compressed, with one of the > +extensions: ``.tar'', ``.tar.gz'', ``.tar.bz2'', or ``.tar.xz''. The file > does > +not need to exist, but all parent directories must exist. > + > > A package database is a tar file, optionally compressed. The valid > extensions are... > > Drop "valid extensions" so it matches the text I know I'd go searching > for in the error message. I'm lazy reading manpages. > > This might also get adjusted a bit depending on whether we enforce > '.db' and '.files' suffixes (before the tar suffix bits). > > -Dan >
I think this makes sense. pacman already depends on the .db so we may as well make this a standard. And while we're at it, it doesn't hurt anyone to solidify the .files extension as well. They're generic enough that I don't think this will bite us in the future. dave
