Patchwork [Documentation,3/3] scripts: Point user to release-notes/README on usage

login
register
mail settings
Submitter Daiane Angolini
Date May 1, 2014, 8:44 p.m.
Message ID <1398977065-6113-3-git-send-email-daiane.angolini@freescale.com>
Download mbox | patch
Permalink /patch/71385/
State Changes Requested
Delegated to: Otavio Salvador
Headers show

Comments

Daiane Angolini - May 1, 2014, 8:44 p.m.
Signed-off-by: Daiane Angolini <daiane.angolini@freescale.com>
---
 scripts/bitbake-metadata2doc.sh | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
Otavio Salvador - May 1, 2014, 9:15 p.m.
On Thu, May 1, 2014 at 5:44 PM, Daiane Angolini <daiane.list@gmail.com> wrote:
> Signed-off-by: Daiane Angolini <daiane.angolini@freescale.com>
> ---
>  scripts/bitbake-metadata2doc.sh | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/scripts/bitbake-metadata2doc.sh b/scripts/bitbake-metadata2doc.sh
> index 9e21ee0..b777003 100755
> --- a/scripts/bitbake-metadata2doc.sh
> +++ b/scripts/bitbake-metadata2doc.sh
> @@ -27,7 +27,8 @@ usage() {
>      else
>          output=1
>      fi
> -    echo "Usage: `basename $0` <yocto directory> <gitdm directory> <start commit> <end commit>" >&$output
> +    echo "Usage: `basename $0` <yocto directory> <gitdm directory> <start commit> <end commit>
> +For detail on how to use it, see ../release-notes/README" >&$output

Maybe add an extra newline between the usage output and the reference
to the README? I think the README reference here does help :)

>      [ -n "$exit_code" ] && exit $exit_code
>  }
>
> --
> 1.8.3.2
>
> --
> _______________________________________________
> meta-freescale mailing list
> meta-freescale@yoctoproject.org
> https://lists.yoctoproject.org/listinfo/meta-freescale

Patch

diff --git a/scripts/bitbake-metadata2doc.sh b/scripts/bitbake-metadata2doc.sh
index 9e21ee0..b777003 100755
--- a/scripts/bitbake-metadata2doc.sh
+++ b/scripts/bitbake-metadata2doc.sh
@@ -27,7 +27,8 @@  usage() {
     else
         output=1
     fi
-    echo "Usage: `basename $0` <yocto directory> <gitdm directory> <start commit> <end commit>" >&$output
+    echo "Usage: `basename $0` <yocto directory> <gitdm directory> <start commit> <end commit>
+For detail on how to use it, see ../release-notes/README" >&$output
     [ -n "$exit_code" ] && exit $exit_code
 }