[Slackbuilds-users] addition for faq or howto

[Willy Sudiarto Raharjo]

> Would it hurt to add some text to the HOWTO page explaining this? I
> know it's pretty elementary stuff, but the HOWTO already details how to
> extract a tarball and launch a shell script from the current directory,
> which are also elementary tasks...
> 
> Proposed text to add to the end of "Step 2 - Read the README":
> 
> ---cut-here---
> If the README mentions any options controlled by environment variables,
> you can set these options now by running:
> 
>    export VARIABLE=value
> 
> For instance, if the README says you can build against SDL 2.0 by setting
> SDL2=yes in the environment, you would type:
> 
>   export SDL2=yes
> 
> If there are multiple options, you can use multiple export commands.
> 
> If you're unsure, don't set any variables here. In most cases, the
> SlackBuild maintainer has made the default behaviour (no options) the
> most common or most useful way to build the package.
> ---cut-here---
> 
> ...yes, it's possible (and "cleaner") to just say SDL2=yes
> ./whatever.SlackBuild in Step 4, but the way the howto is split up
> into steps, it would make less sense for step 4 to effectively say "Oh,
> by the way, you should have noticed if there were environment variable
> options in step 2". So Step 2 has to mention them, since that's where
> they're visible.

IMO, it would be best to put the steps in step 4 since it's how you run
the script that matters. In step 2 we can tell that maintainers can put
variable-controlled options.


-- 
Willy Sudiarto Raharjo

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 195 bytes
Desc: OpenPGP digital signature
URL: <http://lists.slackbuilds.org/pipermail/slackbuilds-users/attachments/20180520/f742fd16/attachment.asc>