Professional Web Applications Themes

How abouta standard 'doc' directory? - Ruby

-talk, When you install a package, the installer (setup.rb/install.rb or a home-grown variant) typically installs files in the following directories: $prefix/bin $prefix/lib/ruby/site_ruby/1.x/foo/... $prefix/share/foo/... and maybe one or two others, where $prefix is something like /usr/local or C:/Ruby What about agreeing on a standard location for installed doentation? $prefix/doc/foo/ README api/ etc... Many packages come with some doentation and, as far as I know, don't install them anywhere. The one exception I know of is 'ri'. We need to define a standard and apply it (update install.rb, particularly). Gavin...

  1. #1

    Default How abouta standard 'doc' directory?

    -talk,

    When you install a package, the installer (setup.rb/install.rb or a
    home-grown variant) typically installs files in the following directories:

    $prefix/bin
    $prefix/lib/ruby/site_ruby/1.x/foo/...
    $prefix/share/foo/...

    and maybe one or two others, where $prefix is something like
    /usr/local or C:/Ruby

    What about agreeing on a standard location for installed
    doentation?

    $prefix/doc/foo/
    README
    api/
    etc...

    Many packages come with some doentation and, as far as I know,
    don't install them anywhere. The one exception I know of is 'ri'.

    We need to define a standard and apply it (update install.rb,
    particularly).

    Gavin


    Gavin Sinclair Guest

  2. #2

    Default Re: How abouta standard 'doc' directory?

    On Saturday, 27 September 2003 at 9:35:00 +0900, Gavin Sinclair wrote:
    > -talk,
    >
    > What about agreeing on a standard location for installed
    > doentation?
    >
    > $prefix/doc/foo/
    > README
    > api/
    > etc...
    >
    How about

    /usr/local/doc/ruby/foo

    I see this on OS X and FreeBSD. In fact, on FreeBSD I have

    /usr/local/doc/squeak-3.0/
    -r--r--r-- 1 root wheel 3642 Dec 26 2001 BUILD.UnixSqueak
    -r--r--r-- 1 root wheel 4142 Dec 26 2001 COPYING
    -r--r--r-- 1 root wheel 18927 Dec 26 2001 COPYRIGHT
    -r--r--r-- 1 root wheel 9745 Dec 26 2001 LICENSE
    -r--r--r-- 1 root wheel 14191 Dec 26 2001 README.CodingStandards

    --
    Jim Freeze
    ----------
    Flugg's Law:
    When you need to knock on wood is when you realize that the
    world is composed of vinyl, naugahyde and aluminum.

    Jim Freeze Guest

  3. #3

    Default Re: How abouta standard 'doc' directory?

    Jim Freeze wrote:
    > On Saturday, 27 September 2003 at 9:35:00 +0900, Gavin Sinclair wrote:
    >
    >>-talk,
    >>
    >>What about agreeing on a standard location for installed
    >>doentation?
    >>
    >> $prefix/doc/foo/
    >> README
    >> api/
    >> etc...
    >>
    >
    >
    > How about
    >
    > /usr/local/doc/ruby/foo
    I don't know how it got there, but I've already got:

    $ ls /usr/local/share/doc/ruby
    optp-0.10.1/


    Joel VanderWerf Guest

  4. #4

    Default Re: How abouta standard 'doc' directory?

    On Saturday, September 27, 2003, 10:46:16 AM, Jim wrote:
    > On Saturday, 27 September 2003 at 9:35:00 +0900, Gavin Sinclair wrote:
    >> -talk,
    >>
    >> What about agreeing on a standard location for installed
    >> doentation?
    >>
    >> $prefix/doc/foo/
    >> README
    >> api/
    >> etc...
    >>
    > How about
    > /usr/local/doc/ruby/foo
    Sorry, that's what I meant.

    Currently, I have

    $ ls /usr/local/doc/ruby/
    ri-1.8b ruby-1.8.0

    And Joel mentioned optp. I know ri uses a home-grown installer,
    and optp is now standard library, but I'll see if I can find out
    how it might get there.

    It's pretty common for doentation directories, in particular, to
    have version numbers associated. Is that something we would want to
    expect with ruby packages?

    Gavin


    Gavin Sinclair Guest

  5. #5

    Default Re: How abouta standard 'doc' directory?

    * Joel VanderWerf <vjoelPATH.Berkeley.EDU> [0902 02:02]:
    > Jim Freeze wrote:
    > >On Saturday, 27 September 2003 at 9:35:00 +0900, Gavin Sinclair wrote:
    > >>What about agreeing on a standard location for installed
    > >>doentation?
    > >> $prefix/doc/foo/
    > >> README
    > >> api/
    > >> etc...
    > >How about
    > >
    > > /usr/local/doc/ruby/foo
    > I don't know how it got there, but I've already got:
    >
    > $ ls /usr/local/share/doc/ruby
    > optp-0.10.1/
    If you use the ports system, it'll create docs and examples directories,
    but that's something the FreeBSD guys are adding in (I know because I
    committed about a dozen NetBSD packages and did the same thing).

    --
    When a Banker jumps out of a window, jump after him -- that's where the
    money is.
    -- Robespierre
    Rasputin :: Jack of All Trades - Master of Nuns

    Rasputin Guest

  6. #6

    Default Re: How abouta standard 'doc' directory?

    On Saturday, 27 September 2003 at 11:46:28 +0900, Gavin Sinclair wrote:
    > On Saturday, September 27, 2003, 10:46:16 AM, Jim wrote:
    >
    > Currently, I have
    >
    > $ ls /usr/local/doc/ruby/
    > ri-1.8b ruby-1.8.0
    >
    > And Joel mentioned optp. I know ri uses a home-grown installer,
    > and optp is now standard library, but I'll see if I can find out
    > how it might get there.
    >
    > It's pretty common for doentation directories, in particular, to
    > have version numbers associated. Is that something we would want to
    > expect with ruby packages?
    >
    Yes

    --
    Jim Freeze
    ----------
    It's the thought, if any, that counts!

    Jim Freeze Guest

  7. #7

    Default Re: How abouta standard 'doc' directory?

    On Sunday, September 28, 2003, 1:57:22 AM, Jim wrote:
    > On Saturday, 27 September 2003 at 11:46:28 +0900, Gavin Sinclair wrote:
    >> On Saturday, September 27, 2003, 10:46:16 AM, Jim wrote:
    >>
    >> Currently, I have
    >>
    >> $ ls /usr/local/doc/ruby/
    >> ri-1.8b ruby-1.8.0
    >>
    >> And Joel mentioned optp. I know ri uses a home-grown installer,
    >> and optp is now standard library, but I'll see if I can find out
    >> how it might get there.
    >>
    >> It's pretty common for doentation directories, in particular, to
    >> have version numbers associated. Is that something we would want to
    >> expect with ruby packages?
    >>
    > Yes
    OK. Nobody has said that we shouldn't have such a standard, nor that
    such a standard should be in some way different, so I suppose we have
    two important steps:

    1. Engineer mkconfig.rb so that the following line appears in
    rbconfig.rb:

    CONFIG["rubydocdir"] = "$(prefix)/doc/ruby"

    On my Cygwin build, that will evaluate to /usr/local/doc/ruby.
    On my Windows build, that will evaluate to
    D:/Software/ruby/doc/ruby.


    2. Ask Minero Aoki to make use of this in setup.rb/install.rb:

    Given
    foo/install.rb
    foo/doc/README
    foo/VERSION (contains "1.5b")

    Then
    cd foo
    ruby install.rb {config|setup|install}

    Produces
    /usr/local/doc/ruby/foo-1.5b/README


    That idea of a "VERSION" file is something I just thought of, and I'm
    sure someone will think of something better.

    After some time for comments on this list (read: I'm about to go out
    for the rest of the day) I'll submit an RCR for the first point above.

    Regards,
    Gavin


    Gavin Sinclair Guest

Similar Threads

  1. Modules not installing to standard LIB directory
    By Mark in forum PERL Modules
    Replies: 2
    Last Post: November 17th, 05:07 PM
  2. Replies: 2
    Last Post: October 8th, 09:57 AM
  3. Replies: 1
    Last Post: July 4th, 12:23 AM
  4. Replies: 1
    Last Post: May 21st, 03:47 PM
  5. Replies: 0
    Last Post: August 17th, 07:52 AM

Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139