Adds swupd-search to illustrate how to search and add bundle.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2026-07-08 13:46:29 +00:00 · 2018-08-09 18:38:31 -07:00
parent ae8f303b35
commit fd33bb2f79
1 changed files with 101 additions and 0 deletions
@@ -0,0 +1,101 @@
+.. _swupd-search: 
+
+Use swupd search to find a bundle
+#################################
+
+.. contents:: :local: 
+   depth: 2
+
+This illustration shows you how to use `swupd search` as a Developer. We 
+assume that you have a basic knowledge of: 
+
+* How :ref:`swupd <swupd-guide>` works 
+* How :ref:`swupd differs <swupd-about>` from *package managers* in other Linux\* distributions 
+
+This document assumes your goal is to use :ref:`mixer` to build your own 
+Clear Linux* OS for Intel® Architecture for a specific use case. Our example 
+is intended to show by example how to search and add a bundle. 
+
+Scenario 1: Data Science with Python
+====================================
+
+We're developing a custom Clear Linux OS for data science with Python. We'll 
+develop our own mix, from which we'll create a release image. That image 
+will be distributed to data center (DC) clients across the United States  
+who need this data to determine DC workload balancing. We need to
+create a tool to analyze energy consumption profiles based on population 
+statistics and consumption data, whose results are heat-maps showing where 
+and when energy consumption peaks in large metropolitan areas. 
+
+So far, we know we need Python data science capabilities. 
+
+First, use :command:`swupd search` with a general term like *Python*. 
+
+#. Enter this command and add 'Python' as the search term: 
+
+   .. code-block:: bash
+
+      sudo swupd search -b Python
+
+   .. note::
+      
+      `swupd search` searches for matching paths in the manifest data. 
+      Enter only one term, or one hyphenated term, at a time. 
+      Use the command :command:`man swupd` to learn more. 
+
+      `-b` flag, or `--binary`, means: Restrict search to program binary paths. 
+
+#. Results of `swupd search` shows the best match for our use case.
+
+   .. code-block:: console
+
+      Bundle python-data-science	(923 MB to install)
+      		/usr/bin/ipython3
+      		/usr/bin/ipython
+
+   .. note::
+
+      Result above is one of several shown in standard output.  
+
+      If the bundle is already installed, [installed] appears in search results. If it doesn't apppear, the bundle needs to be installed. 
+
+#. Add the bundle `python-data-science`.
+
+   .. code-block:: bash
+
+      sudo swupd bundle-add python-data-science
+
+#. When prompted, enter your password. 
+
+   .. note:: 
+
+      You should see console data similar to the following: 
+
+   .. code-block:: console 
+
+      Password: 
+      Downloading packs...
+
+      Extracting python-data-science pack for version 23710
+      ...50%
+      Extracting python-extras pack for version 23830
+      ...100%
+      Starting download of remaining update content. This may take a while...
+      ...100%
+      Finishing download of update content...
+      Installing bundle(s) files...
+      ...100%
+      Calling post-update helper scripts.
+      Successfully installed 1 bundle
+FAQ
+===
+
+Find answers to these common questions: 
+
+* How do I show all :ref:`bundles available<swupd-guide>`?
+
+* How do I :ref:`add new bundles<swupd-guide>`? 
+
+.. note:: 
+   
+   For developers who do not wish to adopt the |CL| Common Tooling Framework (e.g., Autospec, etc.), select the complementary :file:`-dev` bundle in order to successfully build each bundle.