visus
/
toolchain-gcc-arm-embedded
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2 Commits
1 Branch
Branch: main
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'main'
${ noResults }
toolchain-gcc-arm-embedded/share/doc/gcc-arm-none-eabi/html/gccint/Texinfo-Manuals.html

144 lines
6.5KB
Raw Permalink Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

  2. <html>

  3. <!-- Copyright (C) 1988-2020 Free Software Foundation, Inc.

  4. 

  5. Permission is granted to copy, distribute and/or modify this document

  6. under the terms of the GNU Free Documentation License, Version 1.3 or

  7. any later version published by the Free Software Foundation; with the

  8. Invariant Sections being "Funding Free Software", the Front-Cover

  9. Texts being (a) (see below), and with the Back-Cover Texts being (b)

  10. (see below).  A copy of the license is included in the section entitled

  11. "GNU Free Documentation License".

  12. 

  13. (a) The FSF's Front-Cover Text is:

  14. 

  15. A GNU Manual

  16. 

  17. (b) The FSF's Back-Cover Text is:

  18. 

  19. You have freedom to copy and modify this GNU Manual, like GNU

  20.      software.  Copies published by the Free Software Foundation raise

  21.      funds for GNU development. -->

  22. <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->

  23. <head>

  24. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">

  25. <title>Texinfo Manuals (GNU Compiler Collection (GCC) Internals)</title>

  26. 

  27. <meta name="description" content="Texinfo Manuals (GNU Compiler Collection (GCC) Internals)">

  28. <meta name="keywords" content="Texinfo Manuals (GNU Compiler Collection (GCC) Internals)">

  29. <meta name="resource-type" content="document">

  30. <meta name="distribution" content="global">

  31. <meta name="Generator" content="makeinfo">

  32. <link href="index.html#Top" rel="start" title="Top">

  33. <link href="Option-Index.html#Option-Index" rel="index" title="Option Index">

  34. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">

  35. <link href="Documentation.html#Documentation" rel="up" title="Documentation">

  36. <link href="Man-Page-Generation.html#Man-Page-Generation" rel="next" title="Man Page Generation">

  37. <link href="Documentation.html#Documentation" rel="prev" title="Documentation">

  38. <style type="text/css">

  39. <!--

  40. a.summary-letter {text-decoration: none}

  41. blockquote.indentedblock {margin-right: 0em}

  42. blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}

  43. blockquote.smallquotation {font-size: smaller}

  44. div.display {margin-left: 3.2em}

  45. div.example {margin-left: 3.2em}

  46. div.lisp {margin-left: 3.2em}

  47. div.smalldisplay {margin-left: 3.2em}

  48. div.smallexample {margin-left: 3.2em}

  49. div.smalllisp {margin-left: 3.2em}

  50. kbd {font-style: oblique}

  51. pre.display {font-family: inherit}

  52. pre.format {font-family: inherit}

  53. pre.menu-comment {font-family: serif}

  54. pre.menu-preformatted {font-family: serif}

  55. pre.smalldisplay {font-family: inherit; font-size: smaller}

  56. pre.smallexample {font-size: smaller}

  57. pre.smallformat {font-family: inherit; font-size: smaller}

  58. pre.smalllisp {font-size: smaller}

  59. span.nolinebreak {white-space: nowrap}

  60. span.roman {font-family: initial; font-weight: normal}

  61. span.sansserif {font-family: sans-serif; font-weight: normal}

  62. ul.no-bullet {list-style: none}

  63. -->

  64. </style>

  65. 

  66. 

  67. </head>

  68. 

  69. <body lang="en">

  70. <a name="Texinfo-Manuals"></a>

  71. <div class="header">

  72. <p>

  73. Next: <a href="Man-Page-Generation.html#Man-Page-Generation" accesskey="n" rel="next">Man Page Generation</a>, Up: <a href="Documentation.html#Documentation" accesskey="u" rel="up">Documentation</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p>

  74. </div>

  75. <hr>

  76. <a name="Texinfo-Manuals-1"></a>

  77. <h4 class="subsubsection">6.3.7.1 Texinfo Manuals</h4>

  78. 

  79. <p>The manuals for GCC as a whole, and the C and C++ front ends, are in

  80. files <samp>doc/*.texi</samp>.  Other front ends have their own manuals in

  81. files <samp><var>language</var>/*.texi</samp>.  Common files

  82. <samp>doc/include/*.texi</samp> are provided which may be included in

  83. multiple manuals; the following files are in <samp>doc/include</samp>:

  84. </p>

  85. <dl compact="compact">

  86. <dt><samp>fdl.texi</samp></dt>

  87. <dd><p>The GNU Free Documentation License.

  88. </p></dd>

  89. <dt><samp>funding.texi</samp></dt>

  90. <dd><p>The section &ldquo;Funding Free Software&rdquo;.

  91. </p></dd>

  92. <dt><samp>gcc-common.texi</samp></dt>

  93. <dd><p>Common definitions for manuals.

  94. </p></dd>

  95. <dt><samp>gpl_v3.texi</samp></dt>

  96. <dd><p>The GNU General Public License.

  97. </p></dd>

  98. <dt><samp>texinfo.tex</samp></dt>

  99. <dd><p>A copy of <samp>texinfo.tex</samp> known to work with the GCC manuals.

  100. </p></dd>

  101. </dl>

  102. 

  103. <p>DVI-formatted manuals are generated by &lsquo;<samp>make dvi</samp>&rsquo;, which uses

  104. <code>texi2dvi</code> (via the Makefile macro <code>$(TEXI2DVI)</code>).

  105. PDF-formatted manuals are generated by &lsquo;<samp>make pdf</samp>&rsquo;, which uses

  106. <code>texi2pdf</code> (via the Makefile macro <code>$(TEXI2PDF)</code>).  HTML

  107. formatted manuals are generated by &lsquo;<samp>make html</samp>&rsquo;.  Info

  108. manuals are generated by &lsquo;<samp>make info</samp>&rsquo; (which is run as part of

  109. a bootstrap); this generates the manuals in the source directory,

  110. using <code>makeinfo</code> via the Makefile macro <code>$(MAKEINFO)</code>,

  111. and they are included in release distributions.

  112. </p>

  113. <p>Manuals are also provided on the GCC web site, in both HTML and

  114. PostScript forms.  This is done via the script

  115. <samp>maintainer-scripts/update_web_docs_git</samp>.  Each manual to be

  116. provided online must be listed in the definition of <code>MANUALS</code> in

  117. that file; a file <samp><var>name</var>.texi</samp> must only appear once in the

  118. source tree, and the output manual must have the same name as the

  119. source file.  (However, other Texinfo files, included in manuals but

  120. not themselves the root files of manuals, may have names that appear

  121. more than once in the source tree.)  The manual file

  122. <samp><var>name</var>.texi</samp> should only include other files in its own

  123. directory or in <samp>doc/include</samp>.  HTML manuals will be generated by

  124. &lsquo;<samp>makeinfo --html</samp>&rsquo;, PostScript manuals by <code>texi2dvi</code>

  125. and <code>dvips</code>, and PDF manuals by <code>texi2pdf</code>.

  126. All Texinfo files that are parts of manuals must

  127. be version-controlled, even if they are generated files, for the

  128. generation of online manuals to work.

  129. </p>

  130. <p>The installation manual, <samp>doc/install.texi</samp>, is also provided on

  131. the GCC web site.  The HTML version is generated by the script

  132. <samp>doc/install.texi2html</samp>.

  133. </p>

  134. <hr>

  135. <div class="header">

  136. <p>

  137. Next: <a href="Man-Page-Generation.html#Man-Page-Generation" accesskey="n" rel="next">Man Page Generation</a>, Up: <a href="Documentation.html#Documentation" accesskey="u" rel="up">Documentation</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p>

  138. </div>

  139. 

  140. 

  141. 

  142. </body>

  143. </html>