[MacPorts] #39051: The example portfile in the "doc" folder of base should pass lint
MacPorts
noreply at macports.org
Mon Jun 3 18:26:51 PDT 2013
#39051: The example portfile in the "doc" folder of base should pass lint
--------------------------+--------------------------------
Reporter: egall@… | Owner: macports-tickets@…
Type: defect | Status: new
Priority: Normal | Milestone:
Component: base | Version: 2.1.3
Resolution: | Keywords:
Port: exampleport |
--------------------------+--------------------------------
Comment (by ryandesign@…):
Replying to [comment:5 egall@…]:
> Replying to [comment:4 ryandesign@…]:
> > #39321 wants to delete the entire old "doc" directory.
>
> That's a different one.
Oh... you're right, my mistake.
Replying to [comment:8 egall@…]:
> Replying to [comment:6 larryv@…]:
> >
> > Useful to whom?
>
> People who've downloaded the source tarball and don't want to open a web
browser just to view documentation? It's common practice to include
documentation in source tarballs; people expect docs to be in source
tarballs, or else they wouldn't keep including them in their own source
tarballs.
MacPorts documentation is fractured into many different sources: the
guide, the main web site, the trac wiki, the manpages, and some random
text files. Only the latter two have been included in our source tarballs
thus far, and I have no especially urgent interest in including
documentation from the other sources in the tarball. To my knowledge
nobody has ever requested that.
And as was stated, most of what's in the doc directory today is not
intended for the user to look at directly. The only files that are are the
INTERNALS file and the exampleport directory. Everything else is there to
be installed with `make install`.
There is a wide variety of software in the world, with many different ways
of being built, and a correspondingly huge number of things that could
appear in a portfile, limited only by the extents of the Tcl language. I
really don't feel that a single so-called example port is useful,
especially as it gets out of date over time. If the exampleport directory
is to be kept at all, I'd prefer to replace its contents with a README
that names a half dozen or so ports in the ports tree that would serve as
good simple examples of various techniques. But the guide would probably
be a more natural place for such documentation to go.
--
Ticket URL: <https://trac.macports.org/ticket/39051#comment:9>
MacPorts <http://www.macports.org/>
Ports system for OS X
More information about the macports-tickets
mailing list