This will be useful for me... thanks Robert. Scott
>-----Original Message----- >From: Robert P. J. Day [mailto:rpj...@crashcourse.ca] >Sent: Friday, November 01, 2013 6:46 AM >To: Rifenbark, Scott M >Cc: Yocto discussion list >Subject: RE: [yocto] filling in the "missing" entries in the ref manual >variable >glossary > >On Thu, 24 Oct 2013, Rifenbark, Scott M wrote: > >> Hey Robert, >> >> You don't need to submit full patches and explanations for these. >> Noting that they are missing and need documenting is perfect. If you >> do have time when you point out a missing variable, providing a brief >> explanation would help. And... reporting what is missing is extremely >> useful. It has been (and will continue to be) an ongoing process of >> fully documenting variables in the reference manual. >> >> Thanks, >> Scott > > for better or worse, here's what i've decided to do. for my own teaching >purposes so i can quickly refer to all the variables related to a single >subject in >front of a class, i started a wiki page which will be an OE variable glossary >broken into sections and grouping related variables. here's the initial result >for >nothing more than variables related to u-boot: > >http://www.crashcourse.ca/wiki/index.php/OE_variable_glossary#U- >Boot_variables > >that entire section took about 10 minutes to write and i now have what i >*think* is a list of every OE variable related to u-boot in the following >format: > > * if a variable is already documented in the ref manual, i just link to it and >leave it at that > * if a variable isn't documented, i add it to the list but >(obviously) without a link > > and since i also want to see the usage of these things, i do a quick "grep" > for >each one, which showed me that nothing seems to be using the documented >"UBOOT_TARGET" variable, but it seems that what >*should* be documented is "UBOOT_MAKE_TARGET" instead. and also, none >of the SPL-related variables are mentioned in the reference manual so i list >them as well. as i said, that section took all of about 10 minutes to write so >it's >not all that time-consuming. > > this is what i'm going to be working on over the next several days, so if > scott >(or anyone else) wants to play along, that page will certainly point out what >variables are missing from the ref manual, as well as any oddities i run across >and someone else can submit patches for the ref manual -- there's just no >way i have the time to create all the patches, but i can certainly at least >point >out what needs patching. > > thoughts? > >rday > >-- > >=========================================================== >============= >Robert P. J. Day Ottawa, Ontario, CANADA > http://crashcourse.ca > >Twitter: http://twitter.com/rpjday >LinkedIn: http://ca.linkedin.com/in/rpjday >=========================================================== >============= > _______________________________________________ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
