documentation.conf:
authorHolger Freyther <zecke@selfish.org>
Fri, 8 Jul 2005 20:20:35 +0000 (20:20 +0000)
committerOpenEmbedded Project <openembedded-devel@lists.openembedded.org>
Fri, 8 Jul 2005 20:20:35 +0000 (20:20 +0000)
    -Clarify on how to use @see and @group to categorize and link
    the configuration.
    Please feel free to update the documentation and add not yet
    documented keys to this file.

conf/documentation.conf

index 48e7e45..19aaf2d 100644 (file)
@@ -13,13 +13,13 @@ BUILD_SYS[doc] = "FIXME"
 BUILD_PREFIX[doc] = "FIXME"
 BUILD_CC_ARCH[doc] = "FIXME"
 
-HOST_ARCH[doc] = "The name of the target architecture. Normally same as the TARGET_ARCH (@see TARGET_ARCH)"
+HOST_ARCH[doc] = "The name of the target architecture. Normally same as the TARGET_ARCH @see TARGET_ARCH @group base"
 HOST_OS[doc] = "The name of the target operating system. Normally the same as the TARGET_OS \
-(@see TARGET_OS)"
-HOST_VENDOR[doc] = "The name of the vendor. Normally same as the TARGET_VENDOR (@see TARGET_VENDOR)"
+@see TARGET_OS @group base"
+HOST_VENDOR[doc] = "The name of the vendor. Normally same as the TARGET_VENDOR @see TARGET_VENDOR"
 HOST_SYS[doc] = "FIXME"
-HOST_PREFIX[doc] = "Normally same as the TARGET_PREFIX (@see TARGET_PREFIX)"
-HOST_CC_ARCH[doc] = "Normally same as the TARGET_CC_ARCH (@see TARGET_CC_ARCH)"
+HOST_PREFIX[doc] = "Normally same as the TARGET_PREFIX @see TARGET_PREFIX @group base"
+HOST_CC_ARCH[doc] = "Normally same as the TARGET_CC_ARCH @see TARGET_CC_ARCH @group base"
 
 TARGET_ARCH[doc] = "Build for which architecture. Examples are arm, i686, sh3, mips, powerpc"
 TARGET_OS[doc]   = "Build for which Operating System. Currently possible values are \