From bf1e5c641351a71aef256e8782855fa33e091503 Mon Sep 17 00:00:00 2001 From: "Robert P. J. Day" Date: Wed, 2 Nov 2011 13:33:07 -0700 Subject: documentation/dev-manual/dev-manual-newbie.xml: Robert P. J. Edits Robert suggested some minor wording changes that are good. (From yocto-docs rev: 50822bc3722e2f3b0a73ed837842ddc5c7595c7b) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-newbie.xml | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) (limited to 'documentation') diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 3eef7460f9..3a57942481 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml @@ -369,7 +369,7 @@ will allow the change, and for ultimately pushing the change from your local Git repository into the project’s upstream (or master) repository. git status: Reports any modified files that - possibly need added and committed. + possibly need to be added and committed. git checkout <branch-name>: Changes your working branch. This command is analogous to “cd”. @@ -423,7 +423,7 @@ In particular, the information covers basic practices that describe roles and actions in a collaborative development environment. Again, if you are familiar with this type of development environment, you might want to just - skip the section. + skip this section. @@ -436,7 +436,7 @@ The maintainer is responsible for allowing changes in from other developers and for organizing the underlying branch structure to reflect release strategies and so forth. You can see who is the maintainer for Yocto Project files by examining the - distro_tracking_fields file in the Yocto Project + distro_tracking_fields.inc file in the Yocto Project meta/conf/distro/include directory. @@ -475,7 +475,7 @@ "master" branch of the Git repository, which is controlled by the project’s maintainer. And, we have a set of developers who independently develop, test, and submit changes to "contrib" areas for the maintainer to examine. - The maintainer then chooses which changes are going to become permanently a part of the project. + The maintainer then chooses which changes are going to become a permanent part of the project. @@ -489,12 +489,15 @@ For more detailed information about these strategies see Git Workflows. - Make Small Changes: It is best to keep your changes you commit + Make Small Changes: It is best to keep the changes you commit small as compared to bundling many disparate changes into a single commit. This practice not only keeps things manageable but also allows the maintainer to more easily include or refuse changes. It is also good practice to leave the repository in a state that allows you to - still successfully build your project. + still successfully build your project. In other words, do not commit half of a feature, + then add the other half in a separate, later commit. + Each commit should take you from one buildable project state to another + buildable state. Use Branches Liberally: It is very easy to create, use, and delete local branches in your working Git repository. You can name these branches anything you like. @@ -527,7 +530,7 @@ send-pull-request that ship with the release to facilitate this workflow. You can find these scripts in the local Yocto Project files Git repository in - scripts. + the scripts directory. Patch Workflow: This workflow allows you to notify the maintainer through an email that you have a change (or patch) you would like considered for the "master" branch of the Git repository. @@ -615,7 +618,7 @@ - When you send a patch, be sure to include a "signed-off-by:" + When you send a patch, be sure to include a "Signed-off-by:" line in the same style as required by the Linux kernel. Adding this line signifies the developer has agreed to the Developer's Certificate of Origin 1.1 as follows: @@ -661,7 +664,7 @@ - When you form a commit, you must follow certain standards established by the + When you create a commit, you must follow certain standards established by the Yocto Project development team. For each commit, you must provide a single-line summary of the change and you almost always provide a more detailed description of what you did (i.e. the body -- cgit v1.2.3-54-g00ecf