The "3.9.1. Pushing a Change Upstream and Requesting a Pull" [1] section says: For help on using these scripts, simply provide the --help argument as follows: $ ~/poky/scripts/create-pull-request --help $ ~/poky/scripts/send-pull-request --help but running the scripts with --help outputs: [ciupicri@hermes poky]$ scripts/create-pull-request --help scripts/create-pull-request: illegal option -- - Usage: create-pull-request [-h] [-o output_dir] [-m msg_body_file] [-s subject] [-r relative_to] [-i commit_id] -u remote [-b branch] .... [ciupicri@hermes poky]$ scripts/send-pull-request --help scripts/send-pull-request: illegal option -- - Usage: send-pull-request [-h] [-a] [-c] [[-t email]...] -p pull-dir ... [1] http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#pushing-a-change-upstream
Does -h work for you? If so, we should update the 3.9.1 section to use -h, which is what the scripts themselves document in their usage statement.
Yes, -h works fine, I forgot to mention it. By the way, the developers might find this helpful - http://stackoverflow.com/questions/402377/using-getopts-in-bash-shell-script-to-get-long-and-short-command-line-options As a side note, I must say that I didn't understand what's with those scripts and I used raw git in the end. Another problem was the fact I didn't know to which mailing list I needed to send my patch.
Paul E. has submitted a patch for review in his yocto-docs update for Jul 2.
(In reply to comment #2) > Yes, -h works fine, I forgot to mention it. > Great. > By the way, the developers might find this helpful - > http://stackoverflow.com/questions/402377/using-getopts-in-bash-shell-script- > to-get-long-and-short-command-line-options The ommision of long opts was deliberate. It kept things simpler. If this is a stumbling block for people, I'll consider accepting a patch. > As a side note, I must say that I didn't understand what's with those > scripts and I used raw git in the end. What do you mean? You didn't understand how to use them? There are some examples provided, did you find those lacking? If so, how? > Another problem was the fact I didn't > know to which mailing list I needed to send my patch. Did you find the mailing list descriptions lacking in some way? If so, how? http://www.yoctoproject.org/community/mailing-lists http://www.yoctoproject.org/docs/current/poky-ref-manual/poky-ref-manual.html#resources-mailinglist I did notice that neither of these references mention "sending patches".
(In reply to comment #4) > (In reply to comment #2) > > As a side note, I must say that I didn't understand what's with those > > scripts and I used raw git in the end. > > What do you mean? You didn't understand how to use them? There are some > examples provided, did you find those lacking? If so, how? The documentation says: Commit the change by using the git commit command and push it to the "contrib" repository. Be sure to provide a commit message that follows the project’s commit standards as described earlier. On the other hand, somewhere on the site it is mentioned that the contrib repository is for pretty regular contributors which wasn't my case. > > Another problem was the fact I didn't > > know to which mailing list I needed to send my patch. > > Did you find the mailing list descriptions lacking in some way? If so, how? > http://www.yoctoproject.org/community/mailing-lists > http://www.yoctoproject.org/docs/current/poky-ref-manual/poky-ref-manual. > html#resources-mailinglist > > I did notice that neither of these references mention "sending patches". They say development which suggests that patches are welcome, but what files belong to Yocto and what to Poky? As a new user of this project, I had no idea. I asked someone on #yocto where to send my tiny fix[1] and he said to the openembedded-core list. [1] http://lists.linuxtogo.org/pipermail/openembedded-core/2012-June/024649.html
Section 3.7 "Workflows" in the YP Development Manual (http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#workflows) discusses "contrib" areas. I describes these areas as places where developers or community members can push changes to. I don't see where it limits the description to people that regularly contribute back to the YP. This section is a high-level overview of typical workflow. It could be improved with some cross-referencing to the following sections that describe how to submit a change. I have applied and pushed to yocto-docs/master the fixes to the documentation that Paul Eggleton submitted. These addressed the "-h" issue and also provided more information on the mailing lists in the YP Reference manual. The commits for these in yocto-docs/master are as follows: e9bae0a323af2d95505c5492be985232440842ff 3170ce5e0757951afee13207c117316e33449b39 32e6145b5f41d4eb293f8267ef01d02217143152 a15f629afe46e7217182a1ac077ab59641be9a8c 877a7ecfd1623417d0793a5dd16b66c35b6fdbae I will also make sure that the documentation mentions "sending patches" where the mailing lists are discussed in the YP Reference Manual. ScottR
As mentioned, I reviewed and implemented the patches sent by Paul. I also consulted with Darren Hart over the state of the section that talks about sending patches up via email (http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#submitting-a-patch) to see if it was still relavent. I made some changes that tied the section together with the description of the mailing lists in the YP Reference manual. And, at the request of Darren, I added some advice to the user that would be contributing a lot. Added a note that says to consider using the scripts we supply to formulate and send the patches as well as consider requesting a contrib area in YP and OE. Note that the following commit also contributed to this fix. I forgot to put the "Fixes [YOCTO #2671]" line in the commit description though. http://git.yoctoproject.org/cgit.cgi/yocto-docs/commit/?id=ad75ae45420c43bda974d22b02094237b5c7cc50 Scott
(In reply to comment #6) > I don't see where it limits the description to people that regularly > contribute back to the YP. Section "3.9. How to Submit a Change" [1] says: Poky contributions tree (poky-contrib, git://git.yoctoproject.org/poky-contrib.git) exists for contributors to stage contributions. If people desire such access, please ask on the mailing list. Usually, the Yocto Project team will grant access to anyone with a proven track record of good patches. As a new comer I don't have a proven track record of good patches. Besides it meant sending a request, waiting for it to be granted and only afterwards sending my tiny patch. Too much bureaucracy for some sporadic patches in my humble opinion. [1] http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#how-to-submit-a-change
My apologies on my last comment. I get so used to working with and looking at the "current" version of the manuals and not the published versions that I assumed the text from the current manual. This particular section has been updated. I agree that the information in the current manual focused on the contrib area too much. See the changes here and see if this works better. Take into consideration the entire "How to Submit a Change" section, including the sub-sections. http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#how-to-submit-a-change Scott
In 3.9 regarding the bug-tracking ID: <detailed description of change> [YOCTO #<bug-id>] That might lead people to do: subject multiline detailed description of the change. [YOCTO #<bug-id>] When the proper format would be: subject [YOCTO #<bug-id>] multiline detailed description of the change. 3.9.2 Submitting a Patch Through Emails This section is a bit confusing as the send-pull-request script also sends patches via email. 3.9.2 also claims that git-send-email is the preferred method for sending patches, when in fact send-pull-request is the preferred method. Someone reading only 3.9.2 based on the section title might not realize that the send-pull-request method even exists.
Darren, I have addressed the confusion you indicated in the last comment after the bug was marked resolved. You can examine the changes at http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#how-to-submit-a-change. Scott
Verified.