From: Jim Freeze <jim@...>
Date: 2003-05-29T00:03:36+09:00
Subject: Re: Project Directory Structure

On Wednesday, 28 May 2003 at 23:49:14 +0900, dblack@superlink.net wrote:
> Hi --
> 
> On Wed, 28 May 2003, Jim Freeze wrote:
> 
> >  How do you feel about pluralism in the other dirs?
> >
> >   bin/    => bins/
> >   lib/    => libs/
> >   doc/    => docs/
> >   contrib => contribs/
> >
> >  or are these ok without the 's' suffix since they are abbreviations?
> 
> Disclaimer: I'm a naysayer on this; I think it's basically impossible
> that there will be consensus and uniformity in practice.  So ignore me
> :-) But for what it's worth, I think if you want even a shot at
> consensus, this is probably not the place to introduce an overhaul of
> traditional usage.  And yes, they're abbreviations of (in some cases)
> plurals already :-)

 To bring things back on track, I am not proposing that
 we change the common three letter abbreviations which
 have been in use for 30+ yrs.
 I know that total consensus will never be achieved, and
 that is not the goal.
 
 I also don't think there is sufficient need to belabor 
 changing test -> tests, or example -> examples.

 I orginally proposed examples because I had one vote for
 it from the list (sample(s) and example(s)).
 Then Robert suggested that its plurality should follow the
 others.

 I don't have strong feelings either way about example(s).
 So, unless there is a large uprising, I think that my
 simple skeleton is complete is provides a good usage
 guide. YMMV.

----------
Below is a suggested directory hierarchy.
All of the directories, except possibly test/ ;),
are optional. Most of the filenames listed
are optional but are listed for consistent
spelling and capitalization.


CHANGELOG
INSTALL 
LICENSE
Manifest
README    # if multi lang, README.en, README.ja, etc
TODO      # optional
setup.rb
  bin/
     # ruby executables
     # other executables
  contrib/
     # third party contributions
  doc/  # If multi lang, then use doc.en, doc.ja, etc
     man/       # for unix man
     api/       # rdoc output
     rd/        # if rd based docs
     tutorial/
  example/
  ext/
     ext_name/
       extconf.rb
       ... other source
  lib/
     # .rb files that go into RUBY_LIB
     # may want to use parallel directory structure below
     # site_ruby/<rev>/
  src/
     <other_lang_name>/
  test/
     # test suites. Best if dirs mirror lib/.


-- 
Jim Freeze
----------
Everything journalists write is true, except when they write about
something you know.
		-- Dag-Erling Smorgrav,
		   June 1999, FreeBSD-Stable Mailing List