<div dir="ltr"><div><div class="gmail_extra"><div class="gmail_quote">On Sat, Mar 1, 2014 at 10:26 AM, David Spencer <span dir="ltr"><<a href="mailto:baildon.research@googlemail.com" target="_blank">baildon.research@googlemail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">What do we -- users and maintainers -- think about this? Is it worth<br>
being more consistent?<br clear="all"></blockquote></div><br></div><div class="gmail_extra">There is another interpretation for README, a README contains *about* the package. Rather than having an ABOUT file, README has this information so (as i remember) that is the reason of some README.* files (README.Slackware, README.SBo, etc) [1].<br>
<br></div><div class="gmail_extra">I'm the author of sbo_tools and to me the presence of '%README%' in a *.info file does not have any meaning. When the user execute, as an example, sbo_pkg $(sbo_find enlightenment), it is because the user already made the steps needed to build enlightenment, in this case would be to install its dependencies. BTW, the order of dependencies (to build) in REQUIRES is not mandatory so sbo_tools does not make use of it either :(<br>
</div><div class="gmail_extra"><br></div><div class="gmail_extra">Now, about the interpretation of a README as a "boolean", sorry but to me it does not make sense. If i find a directory with a README file then it is telling me to *read* it and maybe take some decisions about its content. IMHO, the "correct" structure would be<br>
<br>package/<br>├── ABOUT<br>├── README<br>├── package.SlackBuild<br>├── <a href="http://package.info">package.info</a><br>└── slack-desc<br><br></div><div class="gmail_extra">ABOUT: the content of slack-desc without the "handy-ruler".<br>
</div><div class="gmail_extra">README: pre or post steps to build this package. It is optional since some packages does not have dependencies or pre-post steps.<br><br></div><div class="gmail_extra">The main issue is that this would require to edit-review mostly all SlackBuilds, so i am thinking in this:<br>
<br></div><div class="gmail_extra">1. Delete '%README%' from REQUIRES<br></div><div class="gmail_extra">2. Add a READ variable in *.info file. The idea would be something like:<br><br></div><div class="gmail_extra">
READ="" # There is not pre-post steps.<br></div><div class="gmail_extra">READ="README README.Slackware" # Read in this order, README and README.Slackware<br></div><div class="gmail_extra">READ="README.pre-steps README.post-steps README.uninstall" # A more "complex" situation.<br>
<br></div><div class="gmail_extra">Notice that the value of READ it is up to the MAINTAINER, after all it is the one that knows how to document the SlackBuild.<br></div><div class="gmail_extra"><br></div><div class="gmail_extra">
This can be done gradually (whenever a MAINTAINER wants to do it) or it can be done with an script [2] , it can be useful to any tools [3] and there is no need to edit-review all SlackBuilds.<br></div><div class="gmail_extra">
<br>[1] find /usr/ports/14.1/ -iname "README*" | grep -vE 'README$'<br></div><div class="gmail_extra">[2] Something like (pseudocode):<br></div><div class="gmail_extra">if ! grep README in REQUIRES; then<br>
</div><div class="gmail_extra"> echo "README=''" >> *.info<br></div><div class="gmail_extra">else<br></div> echo "README='$(ls README*)'" >> *.info<br></div>fi<br><div><div>
<div><div class="gmail_extra">[3] the existence of this variable with a value would act now as a boolean ;)<br></div><div class="gmail_extra"><br></div><div class="gmail_extra">-- <br><div dir="ltr">Antonio Hernández Blas | Oaxaca, México, Mx.<br>
<a href="https://github.com/nihilismus" target="_blank">https://github.com/nihilismus</a> | <a href="https://bitbucket.org/nihilismus" target="_blank">https://bitbucket.org/nihilismus</a> | <a href="https://twitter.com/nihilipster" target="_blank">https://twitter.com/nihilipster</a></div>
</div></div></div></div></div>