summaryrefslogtreecommitdiffstats
path: root/documentation/README
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/README')
-rw-r--r--documentation/README18
1 files changed, 13 insertions, 5 deletions
diff --git a/documentation/README b/documentation/README
index c27ed86a33..e8aed86eb4 100644
--- a/documentation/README
+++ b/documentation/README
@@ -357,13 +357,16 @@ The sphinx.ext.intersphinx extension is enabled by default
357so that we can cross reference content from other Sphinx based 357so that we can cross reference content from other Sphinx based
358documentation projects, such as the BitBake manual. 358documentation projects, such as the BitBake manual.
359 359
360References to the BitBake manual can be done: 360References to the BitBake manual can directly be done:
361 - With a specific description instead of the section name: 361 - With a specific description instead of the section name:
362 :ref:`Azure Storage fetcher (az://) <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` 362 :ref:`Azure Storage fetcher (az://) <bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`
363 - With the section name: 363 - With the section name:
364 :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax` option 364 :ref:`bitbake-user-manual/bitbake-user-manual-intro:usage and syntax` option
365 - Linking to the entire BitBake manual: 365
366 :doc:`BitBake User Manual <bitbake:index>` 366If you want to refer to an entire document (or chapter) in the BitBake manual,
367you have to use the ":doc:" macro with the "bitbake:" prefix:
368 - :doc:`BitBake User Manual <bitbake:index>`
369 - :doc:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata`" chapter
367 370
368Note that a reference to a variable (:term:`VARIABLE`) automatically points to 371Note that a reference to a variable (:term:`VARIABLE`) automatically points to
369the BitBake manual if the variable is not described in the Reference Manual's Variable Glossary. 372the BitBake manual if the variable is not described in the Reference Manual's Variable Glossary.
@@ -372,6 +375,11 @@ BitBake manual as follows:
372 375
373 :term:`bitbake:BB_NUMBER_PARSE_THREADS` 376 :term:`bitbake:BB_NUMBER_PARSE_THREADS`
374 377
378This would be the same if we had identical document filenames in
379both the Yocto Project and BitBake manuals:
380
381 :ref:`bitbake:directory/file:section title`
382
375Submitting documentation changes 383Submitting documentation changes
376================================ 384================================
377 385