On 9 September 2017 at 16:07, Fam Zheng <[email protected]> wrote: > On Sat, 09/09 13:07, Peter Maydell wrote: >> On 9 September 2017 at 06:45, Fam Zheng <[email protected]> wrote: >> > Signed-off-by: Fam Zheng <[email protected]> >> > Message-Id: <[email protected]> >> > --- >> > scripts/archive-source.sh | 31 +++++++++++++++++++++++++++++++ >> > 1 file changed, 31 insertions(+) >> > create mode 100755 scripts/archive-source.sh >> > >> > diff --git a/scripts/archive-source.sh b/scripts/archive-source.sh >> > new file mode 100755 >> > index 0000000000..1de369532e >> > --- /dev/null >> > +++ b/scripts/archive-source.sh >> > @@ -0,0 +1,31 @@ >> > +#!/bin/sh >> > +# >> > +# Author: Fam Zheng <[email protected]> >> > +# >> > +# Create archive of source tree, including submodules >> > +# >> > +# This code is licensed under the GPL version 2 or later. See >> > +# the COPYING file in the top-level directory. >> >> So is this the script that for instance Mike Roth would use >> to create the release tarballs? If it isn't, should it be? > > I don't know the workflow of release tarballs, there is ./scripts/make-release > for that. So this one is not. > >> Is it intended for end users to create tarballs with, or >> is it really just a helper script for the docker stuff? >> If the latter, it would be helpful to say so. If the former, >> it could really use more usage information/documentation... > > I'm not sure what end users would use this for, but it should do its work just > the same.. What kind of usage information do you suggest? More explaination in > the header, or in the "usage" output when no target is specified, or a "-h" > option for help?
Basically, if it's a special purpose script that is only being used by docker, then it should clearly say that so that anybody who looks at it will know it's not something relevant to them. If it's not special purpose then it should say what it's for and how you use it. Just putting this in comments at the top of the script is fine. thanks -- PMM
