Doc Name Update

Charge Codes:

• 2150-002-602 - 21 Documentation

Naming convention summary for User Guide:
PCR [9023] was the original PCR to create consistent names for all Deos documents delivered to the customer within OpenArbor.

• Document Title: In accordance with our DO-178C PSAC Table 1 "<component name> User Guide"; eg. "ANSI User Guide". See PCR [8832 Comment 133]. Titles are visible within the documents themselves (on the title page and when referencing another document by name), and within the Table of Contents in Open Arbor.
  
• Generated file name matches document title: "ansi-user-gude.htm". Use all lower case, and dashes not underlines.
  

Naming convention summary for Release Notes:
PCR [9152] updates titles of release-notes.

• Document Title: The title for release notes is auto-generated by common/build-utils/os-relnotes-bookinfo.xml as "<component name> Release Notes"; eg., ANSI Release Notes, version x.y.z. See PCR [8832 Comment 133].
  
• If you need the word Deos in your component name, add the line xDeosTitle="Deos" to your configure.ac. This will add it to the generated filename and document title. DON'T USE TRADEMARKS IN THE DOCUMENT TITLE!
• You need to update SVN externals to the latest revision to pick up the change to common build utils.
• Source file name: release-notes.xml
  
• Generated file name matches document title: "ansi-release-notes.htm. Use all lower case, and dashes not underlines.
  

Naming convention summary for Requirements:

• Document Title: In accordance with our DO-178C PSAC Table 1 "Software Requirements and Design for the <component name>". See PCR [8832 Comment 133].
• If you need the word Deos in your document title, add it manually in your component requirements xml/sgm.
• Generated file name: If you use the word deos in the title as part of the <component name> value, use it in the generated file name as well. Use all lower case, and dashes not underlines.
  

Things to Consider

• All document name changes are to be incorporated into the Modelo release:
  • If making updates to a component for the Modelo release, include the document name changes into the release.
  • If there are no planned updates to a component for the Modelo release, perform the document name changes and create a capsule release for Modelo.
• Create a new PCR to perform the updates, and add PCR 9023 to the "Depends on" field. If you have questions or need help, call Kelly or Mike Horgan.
• Update the common bibliography with correct document name. PCR [9019] is used to create/update the common bibliography.
• Update document-numbers-index.txt with new name and numbers as needed. No PCR is required.
• Update all links and text in your document referencing other documents to match the standard
• Any references to the following documents should be updated to reference openarbor-user-guide.htm (a new "master" document that includes these sub documents)
  • openarbor_user_guide_for_gcc.htm
  • openarbor_user_guide_for_trac.htm
  • deos-project-guide.htm
  • deos-quick-start-user-guide.htm

Components

The following table is a list of all components to be included included in either the Deos_Modelo_Initial_Software release or the Deos_Chino_Unplanned_Update_14A release.

Component	Version	Phase	CCB	Who	Remarks
abc	5.3.3.1	Stable	Yes	MH	Test Report
component-descriptors	2.1.0	Stable	Yes	RLF	Test Report
dart	1.2.0	Stable	Yes	RLF	Test Report
dds-docs	4.0.0	Stable	Yes	KL	Test Report
deos-training	3.0.0	Stable	Yes	MD	Test Report
deos-name	6.9.4	Stable	Yes	MWL	Test Report
desk-python-tools	4.9.5	Stable	Yes	AR	Test Report
ftpserver	7.6.2	Stable	Yes	AR	Test Report
gdbserver	8.0.3.1	Stable	Yes	RR	Test Report
hyperstart	8.6.1	Stable	Yes	RR	Test Report
inetd	7.0.0	Stable	Yes	gk/kl	Test Report
integ-tool-command-line	3.8.0	Stable	Yes	gk	Test Report
ioi-api	4.0.1	Stable	Yes	MH	Test Report
ioi-config-tool	3.4.5	Stable	Yes	gk	Test Report
ioi-cvt-win32	1.5.5	Stable	Yes	GK/ML	Test Report
ioi-examples	3.0.0	Stable	Yes	KL	Test Report
ioi-ringBuffer	4.0.2	Stable	Yes	MWL	Test Report
kernel	8.2.0	Stable	Yes	RLF	Test Report
kernel-examples	3.0.0	Stable	Yes	KL	Test Report
lwip	3.5.0	Stable	Yes	AR	Test Report
registry-cvt-win32	1.1.0	Stable	Yes	GK	Test Report
rtl-buton	0.3.0	Stable	Yes	AR	Test Report
shared-python-tools	1.11.2	Stable	Yes	AR	Test Report
socket-examples	2.0.0	Stable	Yes	KL	Test Report
static-video-library	7.2.1	Stable	Yes	RR	Test Report
status-monitor	8.7.1	Stable	Yes	gk/kl	Test Report
systemvideostreams	6.5.0	Stable	Yes	KL	Test Report

Components still needing updates

The following components may still require documentation updates but were allowed to be shipped with old names provided they did not cause broken links within the distributed set of documentation. Sales/Marketing may require the updates prior to the next general sales release which would be used for subsequent evaluations.

• emac, 4.0.0
• emac-prl, 2.0.0
• ep440c-platform-boot, 2.0.0
• ep440c-platform-configuration, 3.2.1
• ep440c-platform-pal, 3.0.2
• ep440c-platform-registry , 2.1.0
• ImageAPI, 8.0.1
• tsec-durant, 2.0.0
• tsec-durant-prl, 2.0.0
• qemu-ppc-openbios, 1.0.0
• startup-gcc, 7.1.2 (?)
• xcalibur1002-platform-boot, 1.0.0
• xcalibur1002-platform-configuration, 1.2.0
• xcalibur1002-platform-pal, 1.1.0

In addition optional components such as CFFS, TDL, AFDX, 653P4 may not have been shipped as part of the Modelo_Program, Chino_Program, or Tostones_Program, and will eventually need updates as part of the next customer shipment which receives those components.