📄 ref.description.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>description</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="define_proc"HREF="ref.define-proc.html"><LINKREL="NEXT"TITLE="display"HREF="ref.display.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.define-proc.html"ACCESSKEY="P">Prev</A></TD><TDWIDTH="80%"ALIGN="center"VALIGN="bottom"></TD><TDWIDTH="10%"ALIGN="right"VALIGN="bottom"><AHREF="ref.display.html"ACCESSKEY="N">Next</A></TD></TR></TABLE><HRALIGN="LEFT"WIDTH="100%"></DIV><H1><ANAME="REF.DESCRIPTION"><SPANCLASS="PROPERTY">description</SPAN></H1><DIVCLASS="REFNAMEDIV"><ANAME="AEN4219"></A><H2>Name</H2>Property <SPANCLASS="PROPERTY">description</SPAN> -- Provide a textual description for an option.</DIV><DIVCLASS="REFSYNOPSISDIV"><ANAME="AEN4223"><H2>Synopsis</H2><TABLEBORDER="5"BGCOLOR="#E0E0F0"WIDTH="70%"><TR><TD><PRECLASS="SYNOPSIS">cdl_option <name> { description <text> …}</PRE></TD></TR></TABLE></DIV><DIVCLASS="REFSECT1"><ANAME="AEN4225"></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>At present there is no way of providing any sort of formatting mark-upin a description. It is possible that future versions of theconfiguration tools will provide some control over the way thedescription text gets rendered.</P></DIV><DIVCLASS="REFSECT1"><ANAME="AEN4235"></A><H2>Example</H2><TABLEBORDER="5"BGCOLOR="#E0E0F0"WIDTH="70%"><TR><TD><PRECLASS="PROGRAMLISTING">cdl_option CYGDBG_INFRA_DEBUG_TRACE_MESSAGE { display "Use trace text" default_value 1 description " All trace calls within eCos contain a text message which should give some information about the circumstances. These text messages will end up being embedded in the application image and hence there is a significant penalty in terms of image size. It is possible to suppress the use of these messages by disabling this option. This results in smaller code size, but there is less human-readable information available in the trace output, possibly only filenames and line numbers."}</PRE></TD></TR></TABLE></DIV><DIVCLASS="REFSECT1"><ANAME="AEN4238"></A><H2>See Also</H2><P>Properties <AHREF="ref.display.html"><SPANCLASS="PROPERTY">display</SPAN></A> and<AHREF="ref.doc.html"><SPANCLASS="PROPERTY">doc</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.define-proc.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.display.html"ACCESSKEY="N">Next</A></TD></TR><TR><TDWIDTH="33%"ALIGN="left"VALIGN="top"><SPANCLASS="PROPERTY">define_proc</SPAN></TD><TDWIDTH="34%"ALIGN="center"VALIGN="top"><AHREF="reference.html"ACCESSKEY="U">Up</A></TD><TDWIDTH="33%"ALIGN="right"VALIGN="top"><SPANCLASS="PROPERTY">display</SPAN></TD></TR></TABLE></DIV></BODY></HTML>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -