📄 ref.doc.html
字号:
<!-- Copyright (C) 2003 Red Hat, Inc. --><!-- This material may be distributed only subject to the terms --><!-- and conditions set forth in the Open Publication License, v1.0 --><!-- or later (the latest version is presently available at --><!-- http://www.opencontent.org/openpub/). --><!-- Distribution of the work or derivative of the work in any --><!-- standard (paper) book form is prohibited unless prior --><!-- permission is obtained from the copyright holder. --><HTML><HEAD><TITLE>doc</TITLE><meta name="MSSmartTagsPreventParsing" content="TRUE"><METANAME="GENERATOR"CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+"><LINKREL="HOME"TITLE="The eCos Component Writer's Guide"HREF="cdl-guide.html"><LINKREL="UP"TITLE="CDL Language Specification"HREF="reference.html"><LINKREL="PREVIOUS"TITLE="display"HREF="ref.display.html"><LINKREL="NEXT"TITLE="flavor"HREF="ref.flavor.html"></HEAD><BODYCLASS="REFENTRY"BGCOLOR="#FFFFFF"TEXT="#000000"LINK="#0000FF"VLINK="#840084"ALINK="#0000FF"><DIVCLASS="NAVHEADER"><TABLESUMMARY="Header navigation table"WIDTH="100%"BORDER="0"CELLPADDING="0"CELLSPACING="0"><TR><THCOLSPAN="3"ALIGN="center">The <SPANCLASS="APPLICATION">eCos</SPAN> Component Writer's Guide</TH></TR><TR><TDWIDTH="10%"ALIGN="left"VALIGN="bottom"><AHREF="ref.display.html"ACCESSKEY="P">Prev</A></TD><TDWIDTH="80%"ALIGN="center"VALIGN="bottom"></TD><TDWIDTH="10%"ALIGN="right"VALIGN="bottom"><AHREF="ref.flavor.html"ACCESSKEY="N">Next</A></TD></TR></TABLE><HRALIGN="LEFT"WIDTH="100%"></DIV><H1><ANAME="REF.DOC"><SPANCLASS="PROPERTY">doc</SPAN></H1><DIVCLASS="REFNAMEDIV"><ANAME="AEN4278"></A><H2>Name</H2>Property <SPANCLASS="PROPERTY">doc</SPAN> -- The location of online-documentation for a configuration option.</DIV><DIVCLASS="REFSYNOPSISDIV"><ANAME="AEN4282"><H2>Synopsis</H2><TABLEBORDER="5"BGCOLOR="#E0E0F0"WIDTH="70%"><TR><TD><PRECLASS="SYNOPSIS">cdl_option <name> { doc <URL;> …}</PRE></TD></TR></TABLE></DIV><DIVCLASS="REFSECT1"><ANAME="AEN4284"></A><H2>Description</H2><P>Users can only be expected to manipulate configuration optionssensibly if they are given sufficient information about these options.There are three properties which serve to explain an option in plaintext: the <SPANCLASS="PROPERTY">display</SPAN> property gives a textual alias for an option,which is usually more comprehensible than something like<TTCLASS="LITERAL">CYGPKG_LIBC_TIME_ZONES</TT>; the <SPANCLASS="PROPERTY">description</SPAN> propertygives a longer description, typically a paragraph or so; the <SPANCLASS="PROPERTY">doc</SPAN>property specifies the location of additional on-line documentationrelated to a configuration option. In the context of a graphical toolthe <SPANCLASS="PROPERTY">display</SPAN> string will be the primary way for users to identifyconfiguration options; the <SPANCLASS="PROPERTY">description</SPAN> paragraph will be visiblewhenever the option is selected; the on-line documentation will onlybe accessed when the user explicitly requests it.</P><P>The documentation may be an absolute URL, but more generally theon-line documentation will be shipped with the package and can beaccessed via a relative URL. If the package follows the <AHREF="package.html#PACKAGE.HIERARCHY">directory layout conventions</A> thenthe configuration tools will search for the specified html filefirst in the <TTCLASS="FILENAME">doc</TT> subdirectoryof the package, then relative to the package directory itself. The URLmay contain a <TTCLASS="LITERAL">#</TT> character to specify an anchorwithin a page.</P><DIVCLASS="WARNING"><P></P><TABLECLASS="WARNING"BORDER="1"WIDTH="100%"><TR><TDALIGN="CENTER"><B>Warning</B></TD></TR><TR><TDALIGN="LEFT"><P>At the time of writing the <SPANCLASS="APPLICATION">eCos</SPAN> packages in the standarddistribution do not conform to the directory layout conventions whenit comes to the documentation. Instead of organizing the documentationon a per-package basis and placing it in the corresponding<TTCLASS="FILENAME">doc</TT> sub-directories, all thedocumentation is kept in a central location. This should get addressedin a future release of the system. Third party component writersshould follow the layout conventions.</P></TD></TR></TABLE></DIV></DIV><DIVCLASS="REFSECT1"><ANAME="AEN4301"></A><H2>Example</H2><TABLEBORDER="5"BGCOLOR="#E0E0F0"WIDTH="70%"><TR><TD><PRECLASS="PROGRAMLISTING">cdl_package CYGPKG_KERNEL { display "eCos kernel" doc ref/ecos-ref.4.html include_dir cyg/kernel description " This package contains the core functionality of the eCos kernel. It relies on functionality provided by various HAL packages and by the eCos infrastructure. In turn the eCos kernel provides support for other packages such as the device drivers and the uITRON compatibility layer." …}</PRE></TD></TR></TABLE></DIV><DIVCLASS="REFSECT1"><ANAME="AEN4304"></A><H2>See Also</H2><P>Properties <AHREF="ref.description.html"><SPANCLASS="PROPERTY">description</SPAN></A> and<AHREF="ref.display.html"><SPANCLASS="PROPERTY">display</SPAN></A>.</P></DIV><DIVCLASS="NAVFOOTER"><HRALIGN="LEFT"WIDTH="100%"><TABLESUMMARY="Footer navigation table"WIDTH="100%"BORDER="0"CELLPADDING="0"CELLSPACING="0"><TR><TDWIDTH="33%"ALIGN="left"VALIGN="top"><AHREF="ref.display.html"ACCESSKEY="P">Prev</A></TD><TDWIDTH="34%"ALIGN="center"VALIGN="top"><AHREF="cdl-guide.html"ACCESSKEY="H">Home</A></TD><TDWIDTH="33%"ALIGN="right"VALIGN="top"><AHREF="ref.flavor.html"ACCESSKEY="N">Next</A></TD></TR><TR><TDWIDTH="33%"ALIGN="left"VALIGN="top"><SPANCLASS="PROPERTY">display</SPAN></TD><TDWIDTH="34%"ALIGN="center"VALIGN="top"><AHREF="reference.html"ACCESSKEY="U">Up</A></TD><TDWIDTH="33%"ALIGN="right"VALIGN="top"><SPANCLASS="PROPERTY">flavor</SPAN></TD></TR></TABLE></DIV></BODY></HTML>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -