Skip to content

Commit c89f221

Browse files
rename build section headings for clarity
The “Build with GitHub” sections for registered and unregistered users contained duplicate instructions. To streamline the documentation, only the Docker build steps are now documented under the registered users section. Section titles were renamed to better reflect their actual content: - Build with GitHub for unregistered users -> Build from Source - Build with GitHub for registered users -> Build with Docker - Build with GitHub using firmware and extras -> Build from Source (with firmware and extras) Signed-off-by: Abin Joseph <abinjose@qti.qualcomm.com>
1 parent f40fb88 commit c89f221

File tree

6 files changed

+18
-18
lines changed

6 files changed

+18
-18
lines changed

index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ Qualcomm Linux Build Guide
2020
:titlesonly:
2121

2222
topic/k2c-qli-build-ga/introduction
23-
topic/k2c-qli-build-ga/build_frm_source_qsc_cli
2423
topic/k2c-qli-build-ga/build_from_source_github_intro
2524
topic/k2c-qli-build-ga/build_addn_info
25+
topic/k2c-qli-build-ga/build_frm_source_qsc_cli
2626
topic/k2c-qli-build-ga/flash_images
2727
topic/k2c-qli-build-ga/troubleshoot_sync_build_and_flash
2828
topic/k2c-qli-build-ga/how_to

topic/k2c-qli-build-ga/build_addn_info.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
.. rst_class:: flattenforhtml
44

5-
Build with GitHub using firmware and extras
5+
Build from Source (with firmware and extras)
66
============================================
77

88
Use this information to build ``meta-qcom-extras`` layer using selective proprietary sources and binaries/libraries.

topic/k2c-qli-build-ga/build_from_source_github_intro.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
.. rst_class:: flattenforhtml
44

5-
Build with GitHub for registered users
5+
Build from Source
66
=========================================
77

88
Create a build using the prebuilt proprietary binaries/images available on GitHub.

topic/k2c-qli-build-ga/build_landing_page.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,32 +31,32 @@ Build Qualcomm Linux Software
3131
:class-container: get-started-cards
3232

3333

34-
.. grid-item-card:: |icn-book-blue| Build with QSC CLI
34+
.. grid-item-card:: |icn-book-blue| Build from Source
3535
:class-card: card-base-line
3636
:class-title: font-link
3737
:class-body: font-gray-60
38-
:link: build_from_source_qsc_cli
38+
:link: build_from_source_github_intro
3939
:link-type: ref
40-
41-
QSC CLI is a command line interface (CLI) where you can download, compile, and flash the Qualcomm Linux builds through a command line.
4240

43-
.. grid-item-card:: |icn-book-blue| Build with GitHub for registered users
41+
The build workflow provides a set of instructions to setup the host computer environment, sync, and compile. Firmware components are available as prebuilt binaries.
42+
43+
.. grid-item-card:: |icn-book-blue| Build from Source (with firmware and extras)
4444
:class-card: card-base-line
4545
:class-title: font-link
4646
:class-body: font-gray-60
47-
:link: build_from_source_github_intro
47+
:link: build_addn_info
4848
:link-type: ref
4949

50-
The GitHub workflow for registered users provide a set of instructions to setup the host computer environment, sync, and compile. Firmware components are available as prebuilt binaries.
50+
The build workflow (firmware and extras) for registered users provide a set of instructions to setup the host computer environment, sync, and compile. A few of the firmware components are available as source.
5151

52-
.. grid-item-card:: |icn-book-blue| Build with GitHub using firmware and extras
52+
.. grid-item-card:: |icn-book-blue| Build with QSC CLI
5353
:class-card: card-base-line
5454
:class-title: font-link
5555
:class-body: font-gray-60
56-
:link: build_addn_info
56+
:link: build_from_source_qsc_cli
5757
:link-type: ref
58-
59-
The GitHub workflow (firmware and extras) for registered users provide a set of instructions to setup the host computer environment, sync, and compile. A few of the firmware components are available as source.
58+
59+
QSC CLI is a command line interface (CLI) where you can download, compile, and flash the Qualcomm Linux builds through a command line.
6060

6161
Flash Qualcomm Linux Software
6262
------------------------------

topic/k2c-qli-build-ga/howto_sync.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ How does QSC CLI work?
5353

5454
QSC CLI builds the necessary Qualcomm firmware and the Qualcomm Yocto layers.
5555

56-
4. Internally, QSC CLI implements the standalone commands covered in the :doc:`Build with GitHub using firmware and extras <build_addn_info>` and leverages the prebuilt Docker images for the respective Qualcomm style software images. For example, ``LE.QCLINUX.1.0.r1``.
56+
4. Internally, QSC CLI implements the standalone commands covered in the :doc:`Build from Source (with firmware and extras) <build_addn_info>` and leverages the prebuilt Docker images for the respective Qualcomm style software images. For example, ``LE.QCLINUX.1.0.r1``.
5757

5858
View information about QSC CLI commands
5959
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -125,7 +125,7 @@ You can install the ``tree`` command and run it on your workspace. The Yocto wor
125125
- The additional firmware is built.
126126
- The output binaries from these are taken from the firmware
127127
recipes in the Qualcomm Yocto layers.
128-
- For detailed sync and build instructions, see :doc:`Build with GitHub using firmware and extras <build_addn_info>`.
128+
- For detailed sync and build instructions, see :doc:`Build from Source (with firmware and extras) <build_addn_info>`.
129129
|ws_qsc_cli_4|
130130

131131
Refresh the workspace with a new download using QSC CLI

topic/k2c-qli-build-ga/introduction.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ Sync, build, and flash the software
2020

2121
- Unregistered users
2222

23-
If you're an unregistered Qualcomm user, you can sync and build Qualcomm Linux. For more information about using firmware components in the form of binary files, see :doc:`Build with Source with Docker <build_from_source_github_intro>`.
23+
If you're an unregistered Qualcomm user, you can sync and build Qualcomm Linux. For more information about using firmware components in the form of binary files, see :doc:`Build from Source <build_from_source_github_intro>`.
2424

2525
- Registered users
2626

2727
.. note:: You must `register with Qualcomm <https://www.qualcomm.com/support/working-with-qualcomm>`__ to sync and build Qualcomm Linux.
2828

29-
If you're a registered user, you can use any one of the following three methods to sync and build Qualcomm Linux. These methods use the Qualcomm Yocto layers and the supporting base Yocto layers. You can access the source of certain firmware components and Qualcomm tools, which lets you build and download the software.
29+
If you're a registered user, you can use any the following method to sync and build Qualcomm Linux. This method use the Qualcomm Yocto layers and the supporting base Yocto layers. You can access the source of certain firmware components and Qualcomm tools, which lets you build and download the software.
3030

3131
.. list-table::
3232
:header-rows: 1

0 commit comments

Comments
 (0)