wiki:GCI/QA/ImproveEnglish

Version 32 (modified by Karox693, on Dec 8, 2018 at 5:15:45 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
Karox https://devel.rtems.org/wiki/GCI ' If you ever find yourself in need of assistance you can always reach out to gci AT rtems DOT org by email, and one of our mentors will respond as quickly as they can. ' there should be a comma between ' assistance ' and ' you '
Karox https://devel.rtems.org/wiki/WikiStart ' If you know the branch please select the Create Bug for the release in the Releases table. ' there should be a comma between 'branch' and 'please'
Karox https://devel.rtems.org/wiki/TBR/UserManual/Quick_Start ' Below is a link to how to build libraries for use with more complex packages ' it should be edited to be read as ' There is a link provided below on how to build libraries for use with more complex packages. '
Karox https://devel.rtems.org/wiki/TBR/UserManual/Quick_Start ' WARNING: It is absolutely critical that the target name provided to the RTEMS configure command be that same as that used to build binutils, gcc, newlib, and gdb. ' the word 'that' should be replaced by 'the' between 'be' and 'same'
Karox https://devel.rtems.org/wiki/TBR/UserManual/Quick_Start ' Replace 4.11 with the proper version. Also for 4.11 and older, use the erc32 BSP. For 5.1 and newer, use the erc32 BSP. ' there is a missing comma between 'Also' and 'for'
Thegurshack https://devel.rtems.org/wiki/GSoC 'This is by no means an all inclusive list and we are open to suggestions' 'all inclusive' should be 'all-inclusive'
Thegurshack https://devel.rtems.org/wiki/GSoC/GettingStarted 'You will be best served by using a GNU/Linux environment, which could be in a virtual machine for example' there is a missing comma between 'machine' and 'for'
Thegurshack https://devel.rtems.org/wiki/GSoC/GettingStarted 'The goal of this page is to help you get RTEMS compiled and running so you can start the real work.' The word 'with' should be added between 'start' and 'the'
Thegurshack https://devel.rtems.org/wiki/TBR/Website/Wheres_RTEMS 'Just because you downloaded RTEMS and used it in an application, doesn't mean we know anyhting about you, the application, or where it is in use' the word 'anything should be replaced with the word 'everything'
Thegurshack https://devel.rtems.org/wiki/TBR/UserApp/RTEMSApplications 'Avenger Forward Air Defense System' The word 'Defense' should be changed to Defence
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'.
ShyMel? https://www.rtems.org/ 'We strive to provide regular, high quality releases, which we want to work well' the word high quality should have a hypen (high quality)
ShyMel? https://www.rtems.org/ 'January 25, 2018 2018 RTEMS Classes' There are two 2018's
ShyMel? https://devel.rtems.org/wiki/Developer/Git 'mailing list and to synchronize with github at ​https://github.com/RTEMS.' The first github should be capitalized (GitHub?).
ShyMel? https://devel.rtems.org/wiki/Developer/OpenProjects In the API Layers Projects section of the table the owner's name Joel should be capitalized
ShyMel? https://devel.rtems.org/wiki/Developer/OpenProjects 'USB stack - Ask about possible addition of other device types.' Should be rephrased to the possible addition of other device types.
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.
Ludicrous https://www.rtems.org 'Commercial support is available from US and European companies' 'From US' should be changed to 'from the US'.
Ludicrous https://www.rtems.org/news '04/05/2017; High Performance RTEMS SMP Presentation at DASIA2017' 'High Performance' should have a hyphen in it.
Ludicrous https://devel.rtems.org 'you need to build a cross-compiler tool set and RTEMS.' 'tool set' should be a single word (toolset).
Ludicrous https://www.rtems.org/license 'requires graphic to be displayed on website hosted' 'graphic' should be changed to 'graphics'.
Ludicrous https://www.rtems.org/license 'requires graphic to be displayed on website hosted' 'on website hosted' should be rephrased to 'on the website hosted'.

Directions for Mentors

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