wiki:GCI/QA/ImproveEnglish

Version 20 (modified by ShyMel, on Nov 30, 2018 at 12:59:18 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'.
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/ 'April 05, 2017 High Performance RTEMS SMP Presentation at DASIA2017' the word High Performance should have a hypen (High-Performance)
ShyMel? https://www.rtems.org/ 'June 19, 2018 RTEMS Training in October 2018' The first 2018 should have a comma after it.
ShyMel? https://www.rtems.org/ 'January 25, 2018 2018 RTEMS Classes' There are two 2018's
ShyMel? https://www.rtems.org/ 'August 31, 2017 RTEMS Open Training Class' 2017 should have a comma after it.
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.