[Notes] [Git][BuildStream/buildstream][jennis/doc_improvements] 5 commits: cascache.py: Raise ArtifactError on grpc error

[Javier Jardón <gitlab mg gitlab com>]

Title: GitLab

Javier Jardón pushed to branch jennis/doc_improvements at BuildStream / buildstream

Commits:

• fb222ba1
  by Josh Smith at 2018-07-27T08:50:45Z

  cascache.py: Raise ArtifactError on grpc error
  
  This aims to fix issue #502.
  

• 48916b8a
  by Tristan Maat at 2018-07-27T10:22:41Z

  Merge branch 'Qinusty/502' into 'master'
  
  cascache.py: Raise ArtifactError on grpc error
  
  Closes #502
  
  See merge request BuildStream/buildstream!576

• 23e080b9
  by James Ennis at 2018-07-27T11:13:50Z

  README.md: Minor corrections
  

• 196cfffc
  by James Ennis at 2018-07-27T11:13:50Z

  README.md: Direct users towards the tutorial before existing projects:
  
    This patch also removes displaying the projects that live within
    the buildstream-examples repository, as we wish to deprecate this
    repo and migrate the two examples.
    - #438 and #439
  
    In addition to this, both examples do not 'build' in their current
    state.
  

• 2b93574e
  by James Ennis at 2018-07-27T11:13:50Z

  main_install.rst: Add note to refer Windows and macOS users to docker
  

3 changed files:

• README.rst
• buildstream/_artifactcache/cascache.py
• doc/source/main_install.rst

Changes:

README.rst

---

...	...	@@ -25,7 +25,7 @@ BuildStream offers the following advantages:
25	25
26	26	* **Declarative build instructions/definitions**
27	27
28		- BuildStream provides a a flexible and extensible framework for the modelling
	28	+ BuildStream provides a flexible and extensible framework for the modelling
29	29	of software build pipelines in a declarative YAML format, which allows you to
30	30	manipulate filesystem data in a controlled, reproducible sandboxed environment.
31	31
...	...	@@ -61,25 +61,29 @@ How does BuildStream work?
61	61	==========================
62	62	BuildStream operates on a set of YAML files (.bst files), as follows:
63	63
64		-* loads the YAML files which describe the target(s) and all dependencies
65		-* evaluates the version information and build instructions to calculate a build
	64	+* Loads the YAML files which describe the target(s) and all dependencies.
	65	+* Evaluates the version information and build instructions to calculate a build
66	66	graph for the target(s) and all dependencies and unique cache-keys for each
67		- element
68		-* retrieves elements from cache if they are already built, or builds them in a
69		- sandboxed environment using the instructions declared in the .bst files
70		-* transforms/configures and/or deploys the resulting target(s) based on the
	67	+ element.
	68	+* Retrieves previously built elements (artifacts) from a local/remote cache, or
	69	+ builds the elements in a sandboxed environment using the instructions declared
	70	+ in the .bst files.
	71	+* Transforms/configures and/or deploys the resulting target(s) based on the
71	72	instructions declared in the .bst files.
72	73
73	74
74	75	How can I get started?
75	76	======================
76		-The easiest way to get started is to explore some existing .bst files, for example:
	77	+To start using BuildStream, first,
	78	+`install <https://buildstream.gitlab.io/buildstream/main_install.html>`_
	79	+BuildStream onto your machine and then follow our
	80	+`tutorial <https://buildstream.gitlab.io/buildstream/using_tutorial.html>`_.
	81	+
	82	+We also recommend exploring some existing BuildStream projects:
77	83
78	84	* https://gitlab.gnome.org/GNOME/gnome-build-meta/
79	85	* https://gitlab.com/freedesktop-sdk/freedesktop-sdk
80	86	* https://gitlab.com/baserock/definitions
81		-* https://gitlab.com/BuildStream/buildstream-examples/tree/master/build-x86image
82		-* https://gitlab.com/BuildStream/buildstream-examples/tree/master/netsurf-flatpak
83	87
84	88	If you have any questions please ask on our `#buildstream <irc://irc.gnome.org/buildstream>`_ channel in `irc.gnome.org <irc://irc.gnome.org>`_
85	89

buildstream/_artifactcache/cascache.py

---

...	...	@@ -240,7 +240,8 @@ class CASCache(ArtifactCache):
240	240
241	241	except grpc.RpcError as e:
242	242	if e.code() != grpc.StatusCode.NOT_FOUND:
243		- raise
	243	+ raise ArtifactError("Failed to pull artifact {}: {}".format(
	244	+ element._get_brief_display_key(), e)) from e
244	245
245	246	return False
246	247
...	...	@@ -285,6 +286,7 @@ class CASCache(ArtifactCache):
285	286
286	287	except grpc.RpcError as e:
287	288	if e.code() != grpc.StatusCode.NOT_FOUND:
	289	+ # Intentionally re-raise RpcError for outer except block.
288	290	raise
289	291
290	292	missing_blobs = {}

doc/source/main_install.rst

---

1	1	Install
2	2	=======
3		-This section covers how to install BuildStream onto your machine, how to run BuildStream inside a docker image and also how to configure an artifact server.
	3	+This section covers how to install BuildStream onto your machine, how to run
	4	+BuildStream inside a docker image and also how to configure an artifact server.
4	5
	6	+.. note::
	7	+
	8	+ BuildStream is not currently supported natively on macOS and Windows. Windows
	9	+ and macOS users should refer to :ref:`docker`.
5	10
6	11	.. toctree::
7	12	:maxdepth: 2

—
View it on GitLab.
You're receiving this email because of your account on gitlab.com. If you'd like to receive fewer emails, you can adjust your notification settings.