From bbf81c3d693a11c58a03d761d59b395d6c480222 Mon Sep 17 00:00:00 2001 From: Jonathan Maw Date: Wed, 28 Nov 2018 13:02:35 +0000 Subject: doc: Point out that element is optional when commands are run from the workspace This is a part of #222 --- doc/sessions/developing.run | 5 +++ doc/source/developing/workspaces.rst | 7 +++- .../developing-build-after-changes-workspace.html | 46 ++++++++++++++++++++++ 3 files changed, 57 insertions(+), 1 deletion(-) create mode 100644 doc/source/sessions-stored/developing-build-after-changes-workspace.html diff --git a/doc/sessions/developing.run b/doc/sessions/developing.run index eca2af90b..1ae4eb5ad 100644 --- a/doc/sessions/developing.run +++ b/doc/sessions/developing.run @@ -24,6 +24,11 @@ commands: output: ../source/sessions/developing-build-after-changes.html command: build hello.bst +# Rebuild, from the workspace +- directory: ../examples/developing/workspace_hello + output: ../source/sessions/developing-build-after-changes-workspace.html + command: build + # Capture shell output with changes - directory: ../examples/developing/ output: ../source/sessions/developing-shell-after-changes.html diff --git a/doc/source/developing/workspaces.rst b/doc/source/developing/workspaces.rst index b5ed64b2c..653716f72 100644 --- a/doc/source/developing/workspaces.rst +++ b/doc/source/developing/workspaces.rst @@ -50,11 +50,16 @@ We can open workspace_hello/hello.c and make the following change: .. literalinclude:: ../../examples/developing/update.patch :language: diff -Now, rebuild the hello.bst element +Now, rebuild the hello.bst element. .. raw:: html :file: ../sessions/developing-build-after-changes.html +Note that if you run the command from inside the workspace, the element name is optional. + +.. raw:: html + :file: ../sessions/developing-build-after-changes-workspace.html + Now running the hello command using bst shell: .. raw:: html diff --git a/doc/source/sessions-stored/developing-build-after-changes-workspace.html b/doc/source/sessions-stored/developing-build-after-changes-workspace.html new file mode 100644 index 000000000..54e4ece63 --- /dev/null +++ b/doc/source/sessions-stored/developing-build-after-changes-workspace.html @@ -0,0 +1,46 @@ + +
+user@host:~/workspace_hello$ bst build
+
+[--:--:--][][] START   Build
+[--:--:--][][] START   Loading elements
+[00:00:00][][] SUCCESS Loading elements
+[--:--:--][][] START   Resolving elements
+[00:00:00][][] SUCCESS Resolving elements
+[--:--:--][][] START   Resolving cached state
+[00:00:00][][] SUCCESS Resolving cached state
+[--:--:--][][] START   Checking sources
+[00:00:00][][] SUCCESS Checking sources
+
+BuildStream Version 1.3.0+1032.g41813d3a.dirty
+  Session Start: Wednesday, 05-12-2018 at 16:47:38
+  Project:       developing (/home/user/workspace/buildstream/buildstream/doc/examples/developing)
+  Targets:       hello.bst
+
+User Configuration
+  Configuration File:      /home/user/workspace/buildstream/buildstream/doc/run-bst-7ocq4_a7/buildstream.conf
+  Log Files:               /home/user/workspace/buildstream/buildstream/doc/run-bst-7ocq4_a7/logs
+  Source Mirrors:          /home/user/workspace/buildstream/buildstream/doc/run-bst-7ocq4_a7/sources
+  Build Area:              /home/user/workspace/buildstream/buildstream/doc/run-bst-7ocq4_a7/build
+  Artifact Cache:          /home/user/workspace/buildstream/buildstream/doc/run-bst-7ocq4_a7/artifacts
+  Strict Build Plan:       Yes
+  Maximum Fetch Tasks:     10
+  Maximum Build Tasks:     4
+  Maximum Push Tasks:      4
+  Maximum Network Retries: 2
+
+Pipeline
+      cached 9afe69d645f0bee106749bc2101aae16ef437bb51e1b343ef1f16f04f0572efb base/alpine.bst 
+      cached 19f7c50c7a1db9ae4babe9d1f34f4cdbbf2428827d48673861fd1452d6c7e16b base.bst 
+      cached faa419610e7309d36d15926a81a8d75bbc113443c23c8162e63843dd86b5f56a hello.bst Workspace: /home/user/workspace/buildstream/buildstream/doc/examples/developing/workspace_hello
+===============================================================================
+[00:00:00][][] SUCCESS Build
+
+Pipeline Summary
+  Total:       3
+  Session:     0
+  Fetch Queue: processed 0, skipped 0, failed 0 
+  Build Queue: processed 0, skipped 0, failed 0
+
-- cgit v1.2.1