[Notes] [Git][BuildStream/buildstream][danielsilverstone-ct/report-loop]

Daniel pushed to branch danielsilverstone-ct/report-loop at BuildStream / buildstream

Commits:

edc07536

by Tiago Gomes at 2018-10-17T13:49:15Z

README: use correct links for documentation website

155296a7

by Tiago Gomes at 2018-10-17T13:49:15Z

setup.py: use correct link for documentation website

131f95eb

by Tiago Gomes at 2018-10-17T14:15:38Z

Merge branch 'tiagogones/update-links-to-documentation' into 'master'

Update links to documentation website

See merge request BuildStream/buildstream!876

c327d1f3
by Valentin David at 2018-10-17T14:33:40Z
```
Change URL to the Alpine tarball
```

eeb334f2

by Javier Jardón at 2018-10-17T15:03:17Z

Merge branch 'valentindavid/move_alpine_tarball' into 'master'

Change URL to the Alpine tarball

See merge request BuildStream/buildstream!880

b8f69946

by Daniel Silverstone at 2018-10-18T09:32:09Z

_loader/loader.py: Be more explanatory in CircDep exception

When a circular dependency is detected, the reported error hilights
only one part of the loop in question.  This change ensures that
the entire loop is listed so that the user has a greater chance of
easily determining the correct fix.

Signed-off-by: Daniel Silverstone <daniel silverstone codethink co uk>

10 changed files:

README.rst
buildstream/_loader/loader.py
doc/examples/autotools/project.conf
doc/examples/developing/project.conf
doc/examples/integration-commands/project.conf
doc/examples/junctions/autotools/project.conf
doc/examples/running-commands/project.conf
setup.py
tests/integration/project/project.conf
tests/loader/dependencies.py

Changes:

README.rst

  About
  -----
 -.. image:: https://buildstream.gitlab.io/buildstream/_static/release.svg
 +.. image:: https://docs.buildstream.build/_static/release.svg
     :target: https://gitlab.com/BuildStream/buildstream/commits/bst-1.2
 -.. image:: https://buildstream.gitlab.io/buildstream/_static/snapshot.svg
 +.. image:: https://docs.buildstream.build/_static/snapshot.svg
     :target: https://gitlab.com/BuildStream/buildstream/commits/master
  .. image:: https://gitlab.com/BuildStream/buildstream/badges/master/pipeline.svg
@@ -63,7 +63,7 @@ BuildStream offers the following advantages:
  How do I use BuildStream?
  =========================
 -Please refer to the `documentation <https://buildstream.gitlab.io/buildstream/>`_
 +Please refer to the `documentation <https://docs.buildstream.build>`_
  for  information about installing BuildStream, and about the BuildStream YAML format
  and plugin options.
@@ -86,9 +86,9 @@ BuildStream operates on a set of YAML files (.bst files), as follows:
  How can I get started?
  ======================
  To get started, first `install BuildStream by following the installation guide
 -<https://buildstream.gitlab.io/buildstream/main_install.html>`_
 +<https://buildstream.build/install.html>`_
  and then follow our tutorial in the
 -`user guide <https://buildstream.gitlab.io/buildstream/main_using.html>`_.
 +`user guide <https://docs.buildstream.build/main_using.html>`_.
  We also recommend exploring some existing BuildStream projects:

buildstream/_loader/loader.py

@@ -296,12 +296,14 @@ class Loader():
      # Raises:
      #    (LoadError): In case there was a circular dependency error
+     #
 -    def _check_circular_deps(self, element_name, check_elements=None, validated=None):
 +    def _check_circular_deps(self, element_name, check_elements=None, validated=None, sequence=None):
          if check_elements is None:
              check_elements = {}
          if validated is None:
              validated = {}
 +        if sequence is None:
 +            sequence = []
          element = self._elements[element_name]
@@ -314,16 +316,24 @@ class Loader():
              return
          if check_elements.get(element_name) is not None:
 +            # Create `chain`, the loop of element dependencies from this
 +            # element back to itself, by trimming everything before this
 +            # element from the sequence under consideration.
 +            chain = sequence[sequence.index(element_name):]
 +            chain.append(element_name)
              raise LoadError(LoadErrorReason.CIRCULAR_DEPENDENCY,
 -                            "Circular dependency detected for element: {}"
 -                            .format(element.name))
 +                            ("Circular dependency detected at element: {}\n" +
 +                             "Dependency chain: {}")
 +                            .format(element.name, " -> ".join(chain)))
          # Push / Check each dependency / Pop
          check_elements[element_name] = True
 +        sequence.append(element_name)
          for dep in element.deps:
              loader = self._get_loader_for_dep(dep)
 -            loader._check_circular_deps(dep.name, check_elements, validated)
 +            loader._check_circular_deps(dep.name, check_elements, validated, sequence)
          del check_elements[element_name]
 +        sequence.pop()
          # Eliminate duplicate paths
          validated[element_name] = True

doc/examples/autotools/project.conf

@@ -9,5 +9,5 @@ element-path: elements
  # Define some aliases for the tarballs we download
  aliases:
 -  alpine: https://gnome7.codethink.co.uk/tarballs/
 +  alpine: https://bst-integration-test-images.ams3.cdn.digitaloceanspaces.com/
    gnu: http://ftpmirror.gnu.org/gnu/automake/

doc/examples/developing/project.conf

@@ -9,4 +9,4 @@ element-path: elements
  # Define an alias for our alpine tarball
  aliases:
 -  alpine: https://gnome7.codethink.co.uk/tarballs/
 +  alpine: https://bst-integration-test-images.ams3.cdn.digitaloceanspaces.com/

doc/examples/integration-commands/project.conf

@@ -9,4 +9,4 @@ element-path: elements
  # Define an alias for our alpine tarball
  aliases:
 -  alpine: https://gnome7.codethink.co.uk/tarballs/
 +  alpine: https://bst-integration-test-images.ams3.cdn.digitaloceanspaces.com/

doc/examples/junctions/autotools/project.conf

@@ -9,5 +9,5 @@ element-path: elements
  # Define some aliases for the tarballs we download
  aliases:
 -  alpine: https://gnome7.codethink.co.uk/tarballs/
 +  alpine: https://bst-integration-test-images.ams3.cdn.digitaloceanspaces.com/
    gnu: https://ftpmirror.gnu.org/gnu/automake/

doc/examples/running-commands/project.conf

@@ -9,4 +9,4 @@ element-path: elements
  # Define an alias for our alpine tarball
  aliases:
 -  alpine: https://gnome7.codethink.co.uk/tarballs/
 +  alpine: https://bst-integration-test-images.ams3.cdn.digitaloceanspaces.com/

setup.py

@@ -269,7 +269,7 @@ setup(name='BuildStream',
        url='https://buildstream.build',
        project_urls={
            'Source': 'https://gitlab.com/BuildStream/buildstream',
 -          'Documentation': 'https://buildstream.gitlab.io/buildstream/',
 +          'Documentation': 'https://docs.buildstream.build',
            'Tracker': 'https://gitlab.com/BuildStream/buildstream/issues',
            'Mailing List': 'https://mail.gnome.org/mailman/listinfo/buildstream-list'
        },

tests/integration/project/project.conf

@@ -2,7 +2,7 @@
  name: test
  element-path: elements
  aliases:
 -  alpine: https://gnome7.codethink.co.uk/tarballs/
 +  alpine: https://bst-integration-test-images.ams3.cdn.digitaloceanspaces.com/
    project_dir: file://{project_dir}
  options:
    linux:

tests/loader/dependencies.py

@@ -110,6 +110,7 @@ def test_circular_dependency(datafiles):
          element = loader.load(['elements/circulartarget.bst'])[0]
      assert (exc.value.reason == LoadErrorReason.CIRCULAR_DEPENDENCY)
 +    assert ("seconddep" in exc.value.args[0])
  @pytest.mark.datafiles(DATA_DIR)

[Notes] [Git][BuildStream/buildstream][danielsilverstone-ct/report-loop] 6 commits: README: use correct links for documentation website

Daniel pushed to branch danielsilverstone-ct/report-loop at BuildStream / buildstream

Commits:

10 changed files:

Changes: