wiki:GCI/QA/ImproveEnglish

Version 18 (modified by Gedare Bloom, on Nov 21, 2018 at 3:11:47 PM) (diff)

--

Improve English

Table of Contents

  1. Improve English

Task Description

This task is repeatable and involves finding and fixing language problems in RTEMS code and supporting documents and web pages.

Directions for Students

Find and fix 5 spelling, grammar, or other English language errors in source comments within git://git.rtems.org/rtems.git, docs produced from the rtems/doc directory within the RTEMS git repository, the web pages within www.rtems.org, or this wiki. For fixes in the RTEMS git repository, submit a patch with the corrections. For the website, identify the page with the problem and its solution in the table below: only new problems count, so check this table before you submit a correction! For the wiki, make the fix directly yourself.

Your GCI nickname Web Page Problem
ImNumberOne https://www.rtems.org RTEMS is misspelled as RTMES in the title.
ornitokya https://devel.rtems.org/wiki/Developer/OpenProjects 'This is done if you click on the New Ticket link above' A better sentence would be 'This would have already been filled if you clicked on the New Ticket link above.'
ornitokya https://devel.rtems.org/wiki/Projects/OpenLDAP 'In addition to helping me learn valuable porting skills, this project is on of the first steps towards adding needed modern protocols to RTEMS, so that RTEMS can use LDAP.' The part after the comma should be changed, 'this roject is one of the first...'
ornitokya https://devel.rtems.org/wiki/TBR/BSP/Armulator 'Special models were produced during the development of CPUs, notably the ARM9E, ARM10 and ARM11, these models helped with architectural decisions such as Thumb-2 and TrustZone?.'the final part of this statement should be tweaked an example would be 'models helped with architectural decisions in Thumb-2 and TrustZone??.
ornitokya https://devel.rtems.org/wiki/GCI/Coding/POSIXTimingTest#DirectionsforMentors 'It should be based upon the templates in rtems-testing.' the word 'upon' should be changed to 'on'.
ornitokya https://devel.rtems.org/wiki/GCI/Coding/POSIXTimingTest#DirectionsforMentors 'The following is a link to the Comma Separated Value (e.g., .csv) file which is exported from the spreadsheet used to track the status of this effort.' the phrase 'the following' is incorrect and should be replaced with only 'following'.
ABR https://docs.rtems.org/branches/master/user/start/index.html "Build the RTEMS Kernel (Chapter 7 Section 3.2.2 - Building the Kernel) by cloning the repository, running the bootstrap procecure, building and finally installing the kernel:". 'Procedure' misspelt as 'prcecure'.
ABR https://docs.rtems.org/branches/master/user/ecosys/index.html "You can and should select the work-flow that best suites the demands of your project and what you are delivering". 'suites' should be 'suits'
ABR https://docs.rtems.org/branches/master/user/ecosys/index.html "A user can create an archive of the complete build process including all the source code for long term storage."There should be a hyphen in between 'long term' ---> long-term
ABR https://docs.rtems.org/branches/master/user/ecosys/index.html " It’s parts interact with the user, the host environment, and each other to make RTEMS accessible, useable and predictable."'useable' should be replaced with 'usable'
ABR https://docs.rtems.org/branches/master/user/ecosys/index.html "You can use the --strip-components option in tar if your host tar application supports it to remove the parts you do not have write access too or you may need to unpack the tar file somewhere and copy the file tree from the level you have write access from."Instead of 'too' there should be 'to'."
ABR https://docs.rtems.org/branches/master/user/ecosys/index.html "To install a tar file you have downloaded into your new machine’s Downloads directory in your home directoty you would enter:"instead of 'directoty' it should be 'directory'
ABR https://docs.rtems.org/branches/master/user/ecosys/index.html "This is useful if your prefix is not accessiable, for example when building Canadian cross compiled tool sets:".'accessiable' should be replaced with 'accessible'
ABR https://docs.rtems.org/branches/master/user/ecosys/index.html "The option to supressing installing the packages.Create the build set tar."'supressing' should be replaced with 'suppressing'
ABR https://docs.rtems.org/branches/master/user/ecosys/index.html " As a result the ecosystem is documented at the command line level and we leave GUI and IDE integration for users and integrators."after 'as a result' a comma should be added
ABR https://docs.rtems.org/branches/master/user/ecosys/index.html "You can use the --strip-components option in tar if your host tar application supports it to remove the parts you do not have write access too or you may need to unpack the tar file somewhere and copy the file tree from the level you have write access from."instead of 'too' there should be 'to'
ABR https://docs.rtems.org/branches/master/user/overview/index.html "The design and development of RTEMS is located there."'is' should be replaced with 'are'
ABR https://docs.rtems.org/branches/master/user/overview/index.html "The correctness of the system depends not only on the results of computations, but also on the time at which the results are produced."there is an unnecessary comma after computations because we do not need to use a comma while using "Not only _ but also "
ABR https://docs.rtems.org/branches/master/user/overview/index.html "Since software is a synchronous entity, this presents special problems."either 'a' should be removed if it is to refer to synchronous activity or 'a synchronous' should be replaced with 'ashynchronous'
ABR https://docs.rtems.org/branches/master/user/overview/index.html "System components may request the executive to allocate and coordinate resources, and to wait for and trigger synchronizing conditions."there is an unnecessary comma after resources
ABR https://docs.rtems.org/branches/master/user/index.html "The authors have used their best efforts in preparing this material." 'in' should be replaced by 'for'
ABR https://devel.rtems.org/wiki/TBR/UserManual/Quick_Start "Note, the following is for RTEMS 4.11, and assumes you have a valid sparc-rtems4.11-toolchain in your PATH." there should be no comma after 4.11. The irrelevant comas give an unneeded pause and disrupt user flow while reading.

Directions for Mentors

Verify the corrections. For patches, forward to the devel mailing list.