Bug 5386 - Supported IMAGE_FSTYPES are not precisely documented
Summary: Supported IMAGE_FSTYPES are not precisely documented
Status: RESOLVED FIXED
Alias: None
Product: General Docs
Classification: Documentation
Component: docs-general (show other bugs)
Version: unspecified
Hardware: x86 Multiple
: Medium normal
Target Milestone: 1.6
Assignee: Scott Rifenbark
QA Contact:
URL: http://git.yoctoproject.org/cgit/cgit...
Whiteboard: 28 October 2013: RESOLVED
Depends on:
Blocks:
 
Reported: 2013-10-25 17:41 UTC by Laszlo Papp
Modified: 2013-10-28 13:37 UTC (History)
2 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Done (doc changes complete)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Laszlo Papp 2013-10-25 17:41:39 UTC
From the documentation below:

https://www.yoctoproject.org/docs/1.6/poky-ref-manual/poky-ref-manual.html#var-IMAGE_FSTYPES

You can read the following:

"Specifies the formats of the root filesystem created by the OpenEmbedded build system. Available formats are a subset of the supported images listed in IMAGE_TYPES."

IMAGES_TYPES is documented good, but it is not clear what I can pick up from that list as the "subset" is a relative term here.

Based on the subset range, I would either write down the supported types explicitly for IMAGE_FSTYPES, or I would write out what is not contained by the subset.

Thank you in advance!
Comment 1 Saul Wold 2013-10-27 09:41:02 UTC
The subset is relative to the list in IMAGE_TYPES meaning that you would list the types you want created in IMAGE_FSTYPES for your target image.

Scott, I will be back on Tuesday and we can discuss this if you need.
Comment 2 Laszlo Papp 2013-10-27 09:52:51 UTC
OK, I see.

So, the sentence can be misunderstood just like I accidentally I did. I would suggest to clarify the sentence then based on your explanation.

The subset does not mean what is supported, but what the user can put in there, which can also be the complete list then, not just the subset.
Comment 3 Scott Rifenbark 2013-10-28 13:11:23 UTC
Hi, 

The explanation was definitely ambiguous.  I have rewritten it to be clearer.  Let me know if this works.

http://www.yoctoproject.org/docs/1.6/ref-manual/ref-manual.html#var-IMAGE_FSTYPES

Thanks, 
Scott
Comment 4 Laszlo Papp 2013-10-28 13:15:25 UTC
Yes, this is better. I would give an example at least with two selected items to be more explicit, and also consistent with the variables (IMAGE_INSTALL, IMAGE_LINGUAS, IMAGE_NAME, etc) underneath this one in the documentation.
Comment 5 Scott Rifenbark 2013-10-28 13:29:59 UTC
Laszlo, 

Good suggestions.  Try this on for size and let me know what you think.

http://www.yoctoproject.org/docs/1.6/ref-manual/ref-manual.html#var-IMAGES_FSTYPES.

Scott
Comment 6 Laszlo Papp 2013-10-28 13:31:53 UTC
Looks good. I am happy with that, thanks. :)
Comment 7 Scott Rifenbark 2013-10-28 13:37:26 UTC
Updated to RESOLVED.

Thanks, 
Scott