various guide typos

Create issue
Issue #7 resolved
Former user created an issue

I am new to bitbake, so I found the guide to be a nice starting point to review and improve my basic understanding of the tool. However, I found a list of typos/possible style issues: I thought to list them all in a single item, hope this is ok.

  1. Setup BitBake: "and this scriptdoes" --> "and this script does "

4.1.2 Build folder: "expects it’s initial" --> "expects its initial"

4.2.2: "Add the path of our mata-tutorial" --> "Add the path of our meta-tutorial" "BitBake will search all given layer directives" --> "BitBake will search all given layer directories" "with space to a valriabel." --> "with space to a variable."

4.2.3: "This means that if we tell BitBake to search for some path than it will search all directives in BBPATH for somedir/somefile" --> "This means that if we tell BitBake to search for a path like somedir/somefile then it will search all directories in BBPATH for that path" "We will possibly use a local.conf later." [will we use it or not?] --> "We will use a local.conf later."

4.3: "'bitbake --help' or usage information" --> "'bitbake --help' for usage information" "What is not very useful" --> "This is not very useful"

5: "Currently there is non," --> "Currently there is none,"

5.1 "in a director, the cache" --> "in a directory, the cache" "sub sequential" --> "subsequent" "adding a varaible to" --> "adding a variable to" "and add at the end" --> "and add at the end" [no newline] "like debug or releas, " --> "like debug or release, " "recipe what requires 2 steps" --> "recipe, which requires 2 steps"

5.3: "some shell script running as build" --> "first: some shell script running as build"

6.1: "If we would not have this line it could not override the build function from base for." --> "If we did not have this line, we could not override the build function from base class."

6.2: " pyfunc(d)" --> " pyfunc(d) (5)" "addtask mypatch before do_build (5)" --> "addtask mypatch before do_build (6)" "4. The (bitbake python) mypatch function is added and registered as a task that needs to be executed before the build function" --> "4. The (bitbake python) mypatch function is added." add after 5. --> "6. The mypatch function is registered as a task that needs to be executed before the build function"

7.2 "priority 0, so we will change this" --> "priority 0, let us change this"

7.3 "To set a layer priorities" --> "To set a layer's priorities "

8 "encapsulate confiuguration" --> "encapsulate configuration" "bbapend files" --> "bbappend files" "an additional class to layer-tow" --> "an additional class to layer-two"

8.1 "inherits the mybuild class and simply add" --> "inherits the mybuild class and simply adds" "We create this as an other class which we will than use to demonstrate that a class and a recipe make use of inheritance." --> "We create this as another class, which we will then use to demonstrate a class and a recipe which make use of inheritance." "meta-two/recipes-base/third" --> "meta-two/recipes-base/third_01.bb"

8.2 "Append files can be use to add" --> "An append files can be used to add" "the layer needs to load also append files.a" --> "the layer needs to be set up to load also them in addition to normal recipes" "Therefor we change" --> "Therefore we change" " we will see that first new has also has also a patch task." --> "we will see that it also has a patch task."
"append file to run path," --> "append file to run patch,"

8.3 "It is worth to mention" --> "It is worth mentioning"

9 " parts uses variables." --> " parts use variables." "User of such recipes" --> "The user of such recipes"

9.1 "Global variable can" --> "Global variables can"

9.1.2 "myvar_0.1.bb" --> "myvar_0.1.bb" "If we now run bitbake myvar and check the log output in the tmp directory. We will see that we indeed have access to the global MYVAR variable." --> "If we now run bitbake myvar and check the log output in the tmp directory, we will see that we indeed have access to the global MYVAR variable."

9.2 "and the recipe set the needed variables" --> "and the recipe sets the needed variables"

10 consider revising the style of the paragraph. In the list you mix actions, nouns, verbs in -ing form, etc.

Hope this helps

Comments (2)

  1. Harald Achitz repo owner

    great, thanks a lot! Being a non native English speaker I really appreciate this kind of help and bug fixes. I will fix this all those soon as possible, what means expected next weekend.

  2. Harald Achitz repo owner

    what a great report, hope I fixed all accordingly an that the summary in 10 sounds more like English.

    Thanks a lot for the improvements!

  3. Log in to comment