summaryrefslogtreecommitdiffstats
path: root/documentation/overview-manual
diff options
context:
space:
mode:
authorQuentin Schulz <foss@0leil.net>2020-09-17 01:58:59 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:36 +0100
commitc387f0c2543a9dd7f8eca069629ede4bb5ec5dba (patch)
treed0a7fccf9b84915862b1174ae75cd0437a60bb2d /documentation/overview-manual
parent6813141743f4263e6b03fd7294f9cec4ec1a3194 (diff)
downloadpoky-c387f0c2543a9dd7f8eca069629ede4bb5ec5dba.tar.gz
sphinx: replace special quotes with single and double quotes
(From yocto-docs rev: 0aeb7a94abcef3cb3850c753dd0a243f381e6675) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/overview-manual')
-rw-r--r--documentation/overview-manual/overview-manual-development-environment.rst12
-rw-r--r--documentation/overview-manual/overview-manual-development-environment.xml12
-rw-r--r--documentation/overview-manual/overview-manual-yp-intro.rst12
-rw-r--r--documentation/overview-manual/overview-manual-yp-intro.xml12
4 files changed, 24 insertions, 24 deletions
diff --git a/documentation/overview-manual/overview-manual-development-environment.rst b/documentation/overview-manual/overview-manual-development-environment.rst
index 273e1027da..3b5147d732 100644
--- a/documentation/overview-manual/overview-manual-development-environment.rst
+++ b/documentation/overview-manual/overview-manual-development-environment.rst
@@ -238,7 +238,7 @@ open source projects do so.
238 238
239For the Yocto Project, a key individual called the "maintainer" is 239For the Yocto Project, a key individual called the "maintainer" is
240responsible for the integrity of the "master" branch of a given Git 240responsible for the integrity of the "master" branch of a given Git
241repository. The "master" branch is the upstream repository from which 241repository. The "master" branch is the "upstream" repository from which
242final or most recent builds of a project occur. The maintainer is 242final or most recent builds of a project occur. The maintainer is
243responsible for accepting changes from other developers and for 243responsible for accepting changes from other developers and for
244organizing the underlying branch structure to reflect release strategies 244organizing the underlying branch structure to reflect release strategies
@@ -273,19 +273,19 @@ with whatever upstream branch they are working against. They are also
273responsible for straightening out any conflicts that might arise within 273responsible for straightening out any conflicts that might arise within
274files that are being worked on simultaneously by more than one person. 274files that are being worked on simultaneously by more than one person.
275All this work is done locally on the development host before anything is 275All this work is done locally on the development host before anything is
276pushed to a "contrib" area and examined at the maintainers level. 276pushed to a "contrib" area and examined at the maintainer's level.
277 277
278A somewhat formal method exists by which developers commit changes and 278A somewhat formal method exists by which developers commit changes and
279push them into the "contrib" area and subsequently request that the 279push them into the "contrib" area and subsequently request that the
280maintainer include them into an upstream branch. This process is called 280maintainer include them into an upstream branch. This process is called
281submitting a patch or "submitting a change." For information on 281"submitting a patch" or "submitting a change." For information on
282submitting patches and changes, see the 282submitting patches and changes, see the
283":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" 283":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`"
284section in the Yocto Project Development Tasks Manual. 284section in the Yocto Project Development Tasks Manual.
285 285
286In summary, a single point of entry exists for changes into a "master" 286In summary, a single point of entry exists for changes into a "master"
287or development branch of the Git repository, which is controlled by the 287or development branch of the Git repository, which is controlled by the
288projects maintainer. And, a set of developers exist who independently 288project's maintainer. And, a set of developers exist who independently
289develop, test, and submit changes to "contrib" areas for the maintainer 289develop, test, and submit changes to "contrib" areas for the maintainer
290to examine. The maintainer then chooses which changes are going to 290to examine. The maintainer then chooses which changes are going to
291become a permanent part of the project. 291become a permanent part of the project.
@@ -526,7 +526,7 @@ descriptions and strategies on how to use these commands:
526 Git commands unless you have a ``.git`` repository. 526 Git commands unless you have a ``.git`` repository.
527 527
528- *git clone:* Creates a local clone of a Git repository that is on 528- *git clone:* Creates a local clone of a Git repository that is on
529 equal footing with a fellow developers Git repository or an upstream 529 equal footing with a fellow developer's Git repository or an upstream
530 repository. 530 repository.
531 531
532- *git add:* Locally stages updated file contents to the index that 532- *git add:* Locally stages updated file contents to the index that
@@ -537,7 +537,7 @@ descriptions and strategies on how to use these commands:
537 you made. Only changes that have been staged can be committed. 537 you made. Only changes that have been staged can be committed.
538 Commits are used for historical purposes, for determining if a 538 Commits are used for historical purposes, for determining if a
539 maintainer of a project will allow the change, and for ultimately 539 maintainer of a project will allow the change, and for ultimately
540 pushing the change from your local Git repository into the projects 540 pushing the change from your local Git repository into the project's
541 upstream repository. 541 upstream repository.
542 542
543- *git status:* Reports any modified files that possibly need to be 543- *git status:* Reports any modified files that possibly need to be
diff --git a/documentation/overview-manual/overview-manual-development-environment.xml b/documentation/overview-manual/overview-manual-development-environment.xml
index 8415d1dd70..08ad071316 100644
--- a/documentation/overview-manual/overview-manual-development-environment.xml
+++ b/documentation/overview-manual/overview-manual-development-environment.xml
@@ -327,7 +327,7 @@
327 For the Yocto Project, a key individual called the "maintainer" is 327 For the Yocto Project, a key individual called the "maintainer" is
328 responsible for the integrity of the "master" branch of a given Git 328 responsible for the integrity of the "master" branch of a given Git
329 repository. 329 repository.
330 The "master" branch is the upstream repository from which final or 330 The "master" branch is the "upstream" repository from which final or
331 most recent builds of a project occur. 331 most recent builds of a project occur.
332 The maintainer is responsible for accepting changes from other 332 The maintainer is responsible for accepting changes from other
333 developers and for organizing the underlying branch structure to 333 developers and for organizing the underlying branch structure to
@@ -372,7 +372,7 @@
372 might arise within files that are being worked on simultaneously by 372 might arise within files that are being worked on simultaneously by
373 more than one person. 373 more than one person.
374 All this work is done locally on the development host before 374 All this work is done locally on the development host before
375 anything is pushed to a "contrib" area and examined at the maintainers 375 anything is pushed to a "contrib" area and examined at the maintainer's
376 level. 376 level.
377 </para> 377 </para>
378 378
@@ -380,7 +380,7 @@
380 A somewhat formal method exists by which developers commit changes 380 A somewhat formal method exists by which developers commit changes
381 and push them into the "contrib" area and subsequently request that 381 and push them into the "contrib" area and subsequently request that
382 the maintainer include them into an upstream branch. 382 the maintainer include them into an upstream branch.
383 This process is called submitting a patch or "submitting a change." 383 This process is called "submitting a patch" or "submitting a change."
384 For information on submitting patches and changes, see the 384 For information on submitting patches and changes, see the
385 "<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>Submitting a Change to the Yocto Project</ulink>" 385 "<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>Submitting a Change to the Yocto Project</ulink>"
386 section in the Yocto Project Development Tasks Manual. 386 section in the Yocto Project Development Tasks Manual.
@@ -389,7 +389,7 @@
389 <para> 389 <para>
390 In summary, a single point of entry 390 In summary, a single point of entry
391 exists for changes into a "master" or development branch of the 391 exists for changes into a "master" or development branch of the
392 Git repository, which is controlled by the projects maintainer. 392 Git repository, which is controlled by the project's maintainer.
393 And, a set of developers exist who independently develop, test, and 393 And, a set of developers exist who independently develop, test, and
394 submit changes to "contrib" areas for the maintainer to examine. 394 submit changes to "contrib" areas for the maintainer to examine.
395 The maintainer then chooses which changes are going to become a 395 The maintainer then chooses which changes are going to become a
@@ -734,7 +734,7 @@
734 <listitem><para id='git-commands-clone'> 734 <listitem><para id='git-commands-clone'>
735 <emphasis><filename>git clone</filename>:</emphasis> 735 <emphasis><filename>git clone</filename>:</emphasis>
736 Creates a local clone of a Git repository that is on 736 Creates a local clone of a Git repository that is on
737 equal footing with a fellow developers Git repository 737 equal footing with a fellow developer's Git repository
738 or an upstream repository. 738 or an upstream repository.
739 </para></listitem> 739 </para></listitem>
740 <listitem><para> 740 <listitem><para>
@@ -752,7 +752,7 @@
752 Commits are used for historical purposes, for determining 752 Commits are used for historical purposes, for determining
753 if a maintainer of a project will allow the change, 753 if a maintainer of a project will allow the change,
754 and for ultimately pushing the change from your local 754 and for ultimately pushing the change from your local
755 Git repository into the projects upstream repository. 755 Git repository into the project's upstream repository.
756 </para></listitem> 756 </para></listitem>
757 <listitem><para> 757 <listitem><para>
758 <emphasis><filename>git status</filename>:</emphasis> 758 <emphasis><filename>git status</filename>:</emphasis>
diff --git a/documentation/overview-manual/overview-manual-yp-intro.rst b/documentation/overview-manual/overview-manual-yp-intro.rst
index f01d9f7125..823c96d88c 100644
--- a/documentation/overview-manual/overview-manual-yp-intro.rst
+++ b/documentation/overview-manual/overview-manual-yp-intro.rst
@@ -319,14 +319,14 @@ applications using the Yocto Project:
319 319
320 The ``devtool`` command employs a number of sub-commands that allow 320 The ``devtool`` command employs a number of sub-commands that allow
321 you to add, modify, and upgrade recipes. As with the OpenEmbedded 321 you to add, modify, and upgrade recipes. As with the OpenEmbedded
322 build system, recipes represent software packages within 322 build system, "recipes" represent software packages within
323 ``devtool``. When you use ``devtool add``, a recipe is automatically 323 ``devtool``. When you use ``devtool add``, a recipe is automatically
324 created. When you use ``devtool modify``, the specified existing 324 created. When you use ``devtool modify``, the specified existing
325 recipe is used in order to determine where to get the source code and 325 recipe is used in order to determine where to get the source code and
326 how to patch it. In both cases, an environment is set up so that when 326 how to patch it. In both cases, an environment is set up so that when
327 you build the recipe a source tree that is under your control is used 327 you build the recipe a source tree that is under your control is used
328 in order to allow you to make changes to the source as desired. By 328 in order to allow you to make changes to the source as desired. By
329 default, both new recipes and the source go into a workspace 329 default, both new recipes and the source go into a "workspace"
330 directory under the eSDK. The ``devtool upgrade`` command updates an 330 directory under the eSDK. The ``devtool upgrade`` command updates an
331 existing recipe so that you can build it for an updated set of source 331 existing recipe so that you can build it for an updated set of source
332 files. 332 files.
@@ -417,7 +417,7 @@ activities using the Yocto Project:
417 years ago. Both prelink and cross-prelink are maintained in the same 417 years ago. Both prelink and cross-prelink are maintained in the same
418 repository albeit on separate branches. By providing an emulated 418 repository albeit on separate branches. By providing an emulated
419 runtime dynamic linker (i.e. ``glibc``-derived ``ld.so`` emulation), 419 runtime dynamic linker (i.e. ``glibc``-derived ``ld.so`` emulation),
420 the cross-prelink project extends the prelink softwares ability to 420 the cross-prelink project extends the prelink software's ability to
421 prelink a sysroot environment. Additionally, the cross-prelink 421 prelink a sysroot environment. Additionally, the cross-prelink
422 software enables the ability to work in sysroot style environments. 422 software enables the ability to work in sysroot style environments.
423 423
@@ -432,7 +432,7 @@ activities using the Yocto Project:
432 library code can be re-used from shared Copy-On-Write (COW) pages. 432 library code can be re-used from shared Copy-On-Write (COW) pages.
433 433
434 The original upstream prelink project only supports running prelink 434 The original upstream prelink project only supports running prelink
435 on the end target device due to the reliance on the target devices 435 on the end target device due to the reliance on the target device's
436 dynamic linker. This restriction causes issues when developing a 436 dynamic linker. This restriction causes issues when developing a
437 cross-compiled system. The cross-prelink adds a synthesized dynamic 437 cross-compiled system. The cross-prelink adds a synthesized dynamic
438 loader that runs on the host, thus permitting cross-prelinking 438 loader that runs on the host, thus permitting cross-prelinking
@@ -495,7 +495,7 @@ The following list consists of components associated with the
495 Sharing a core set of metadata results in Poky as an integration 495 Sharing a core set of metadata results in Poky as an integration
496 layer on top of OE-Core. You can see that in this 496 layer on top of OE-Core. You can see that in this
497 `figure <#yp-key-dev-elements>`__. The Yocto Project combines various 497 `figure <#yp-key-dev-elements>`__. The Yocto Project combines various
498 components such as BitBake, OE-Core, script glue, and documentation 498 components such as BitBake, OE-Core, script "glue", and documentation
499 for its build system. 499 for its build system.
500 500
501.. _gs-reference-distribution-poky: 501.. _gs-reference-distribution-poky:
@@ -556,7 +556,7 @@ targets:
556 .. note:: 556 .. note::
557 557
558 As best it can, opkg maintains backwards compatibility with ipkg 558 As best it can, opkg maintains backwards compatibility with ipkg
559 and conforms to a subset of Debians policy manual regarding 559 and conforms to a subset of Debian's policy manual regarding
560 control files. 560 control files.
561 561
562.. _gs-archived-components: 562.. _gs-archived-components:
diff --git a/documentation/overview-manual/overview-manual-yp-intro.xml b/documentation/overview-manual/overview-manual-yp-intro.xml
index 2097ed36e5..a2a1f494bb 100644
--- a/documentation/overview-manual/overview-manual-yp-intro.xml
+++ b/documentation/overview-manual/overview-manual-yp-intro.xml
@@ -459,7 +459,7 @@
459 <para>The <filename>devtool</filename> command employs 459 <para>The <filename>devtool</filename> command employs
460 a number of sub-commands that allow you to add, modify, 460 a number of sub-commands that allow you to add, modify,
461 and upgrade recipes. 461 and upgrade recipes.
462 As with the OpenEmbedded build system, recipes 462 As with the OpenEmbedded build system, "recipes"
463 represent software packages within 463 represent software packages within
464 <filename>devtool</filename>. 464 <filename>devtool</filename>.
465 When you use <filename>devtool add</filename>, a recipe 465 When you use <filename>devtool add</filename>, a recipe
@@ -472,7 +472,7 @@
472 control is used in order to allow you to make changes 472 control is used in order to allow you to make changes
473 to the source as desired. 473 to the source as desired.
474 By default, both new recipes and the source go into 474 By default, both new recipes and the source go into
475 a workspace directory under the eSDK. 475 a "workspace" directory under the eSDK.
476 The <filename>devtool upgrade</filename> command 476 The <filename>devtool upgrade</filename> command
477 updates an existing recipe so that you can build it 477 updates an existing recipe so that you can build it
478 for an updated set of source files.</para> 478 for an updated set of source files.</para>
@@ -598,7 +598,7 @@
598 By providing an emulated runtime dynamic linker 598 By providing an emulated runtime dynamic linker
599 (i.e. <filename>glibc</filename>-derived 599 (i.e. <filename>glibc</filename>-derived
600 <filename>ld.so</filename> emulation), the 600 <filename>ld.so</filename> emulation), the
601 cross-prelink project extends the prelink softwares 601 cross-prelink project extends the prelink software's
602 ability to prelink a sysroot environment. 602 ability to prelink a sysroot environment.
603 Additionally, the cross-prelink software enables the 603 Additionally, the cross-prelink software enables the
604 ability to work in sysroot style environments.</para> 604 ability to work in sysroot style environments.</para>
@@ -620,7 +620,7 @@
620 620
621 <para>The original upstream prelink project only 621 <para>The original upstream prelink project only
622 supports running prelink on the end target device 622 supports running prelink on the end target device
623 due to the reliance on the target devices dynamic 623 due to the reliance on the target device's dynamic
624 linker. 624 linker.
625 This restriction causes issues when developing a 625 This restriction causes issues when developing a
626 cross-compiled system. 626 cross-compiled system.
@@ -713,7 +713,7 @@
713 You can see that in this 713 You can see that in this
714 <link linkend='yp-key-dev-elements'>figure</link>. 714 <link linkend='yp-key-dev-elements'>figure</link>.
715 The Yocto Project combines various components such as 715 The Yocto Project combines various components such as
716 BitBake, OE-Core, script glue, and documentation 716 BitBake, OE-Core, script "glue", and documentation
717 for its build system. 717 for its build system.
718 </para></listitem> 718 </para></listitem>
719 </itemizedlist> 719 </itemizedlist>
@@ -791,7 +791,7 @@
791 <note> 791 <note>
792 As best it can, opkg maintains backwards 792 As best it can, opkg maintains backwards
793 compatibility with ipkg and conforms to a subset 793 compatibility with ipkg and conforms to a subset
794 of Debians policy manual regarding control files. 794 of Debian's policy manual regarding control files.
795 </note> 795 </note>
796 </para></listitem> 796 </para></listitem>
797 </itemizedlist> 797 </itemizedlist>