Bug 8233

Summary: Descriptions for IMAGE_POSTPROCESS_COMMAND and IMAGE_PREPROCESS_COMMAND are inconsistent with the rest of the documentation
Product: [Documentation] Reference Reporter: Bogdan Alexandru Voiculescu <bogdanx.a.voiculescu>
Component: handbookAssignee: Scott Rifenbark <srifenbark>
Status: VERIFIED FIXED QA Contact: Bogdan Alexandru Voiculescu <bogdanx.a.voiculescu>
Severity: minor    
Priority: Medium CC: poky.doc.watcher, poky.watcher, srifenbark
Version: 1.9   
Target Milestone: 2.0   
Hardware: x86   
OS: Multiple   
Whiteboard: 16 Sept 2015 - IN PROGRESS REVIEW
OS type for building Yocto: --- Type of Regression: New (Never tested)
Verified: Documentation change: Done (doc changes complete)

Description Bogdan Alexandru Voiculescu 2015-09-01 13:49:18 UTC
Last paragraph usually is:
"If you need to pass the root filesystem path to a command within a function, you can use ${IMAGE_ROOTFS}, which points to the directory that becomes the root filesystem image. See the IMAGE_ROOTFS variable for more information."

For the  IMAGE_POSTPROCESS_COMMAND and IMAGE_PREPROCESS_COMMAND variables 
(http://www.yoctoproject.org/docs/1.9/ref-manual/ref-manual.html#var-IMAGE_POSTPROCESS_COMMAND 
and 
http://www.yoctoproject.org/docs/1.9/ref-manual/ref-manual.html#var-IMAGE_PREPROCESS_COMMAND)

there is a missing phrase:  "See the IMAGE_ROOTFS variable for more information."


So the explanation is shorter: "If you need to pass the root filesystem path to a command within the function, you can use ${IMAGE_ROOTFS}, which points to the directory that becomes the root filesystem image." and there is no reference for "IMAGE_ROOTFS variable"
Comment 1 Scott Rifenbark 2015-09-16 17:12:07 UTC
Hi, 

I have added that cross-reference phrase to both these variables.  You can see the changes here:

  http://www.yoctoproject.org/docs/1.9/ref-manual/ref-manual.html#var-IMAGE_POSTPROCESS_COMMAND

  http://www.yoctoproject.org/docs/1.9/ref-manual/ref-manual.html#var-IMAGE_PREPROCESS_COMMAND

Setting the bug to IN PROGRESS REVIEW.  Let me know if this is good.

Thanks
Comment 2 Scott Rifenbark 2015-09-22 15:10:03 UTC
Setting to 1.0 days to remove from red-flag list.  Changes are in and I am waiting for approval/review.  Will wait a while longer.

Scott
Comment 3 Scott Rifenbark 2015-10-14 19:04:40 UTC
Hi, 

I have had no further feedback on this so am setting to RESOLVED/FIXED and setting the doc flag to "Done."

Scott