[gnome-builder] help: update pipeline references



commit 245b290a420a2eb43010b333029ce61793578f53
Author: Christian Hergert <chergert redhat com>
Date:   Tue Mar 12 17:01:31 2019 -0700

    help: update pipeline references

 doc/help/plugins/building/buildsystem.rst |  2 +-
 doc/help/plugins/building/pipeline.rst    | 10 ++++------
 2 files changed, 5 insertions(+), 7 deletions(-)
---
diff --git a/doc/help/plugins/building/buildsystem.rst b/doc/help/plugins/building/buildsystem.rst
index 4d9fd05ed..9cc40239b 100644
--- a/doc/help/plugins/building/buildsystem.rst
+++ b/doc/help/plugins/building/buildsystem.rst
@@ -2,7 +2,7 @@
 Implementing a Build System
 ###########################
 
-Builder has support for many build systems such as autotools, meson, cmake, etc. The build system knows how 
to find build targets (binaries or scripts that are installed) for the runner, knows how to find build flags 
used by the clang service, and it can define where the build directory is. It also has an associated 
``Ide.BuildPipelineAddin`` (see the next section) that specifies how to do operations like build, rebuild, 
clean, etc.
+Builder has support for many build systems such as autotools, meson, cmake, etc. The build system knows how 
to find build targets (binaries or scripts that are installed) for the runner, knows how to find build flags 
used by the clang service, and it can define where the build directory is. It also has an associated 
``Ide.PipelineAddin`` (see the next section) that specifies how to do operations like build, rebuild, clean, 
etc.
 
 .. code-block:: python3
    :caption: An outline for a Buildsystem
diff --git a/doc/help/plugins/building/pipeline.rst b/doc/help/plugins/building/pipeline.rst
index 513000662..95fe77ce1 100644
--- a/doc/help/plugins/building/pipeline.rst
+++ b/doc/help/plugins/building/pipeline.rst
@@ -46,7 +46,7 @@ loads we will register our stage in the appropriate phase.
    from gi.repository import GObject
    from gi.repository import Ide
 
-   class MyBuildStage(Ide.Object, Ide.BuildStage):
+   class MyPipelineStage(Ide.Object, Ide.PipelineStage):
 
        def do_execute(self, pipeline, cancellable):
            """
@@ -100,16 +100,14 @@ loads we will register our stage in the appropriate phase.
            """
            return False
 
-   class MyPipelineAddin(GObject.Object, Ide.BuildPipelineAddin):
+   class MyPipelineAddin(GObject.Object, Ide.PipelineAddin):
 
        def do_load(self, pipeline):
-           stage = MyBuildStage()
+           stage = MyPipelineStage()
            phase = Ide.PipelinePhase.BUILD | Ide.PipelinePhase.AFTER
-           stage_id = pipeline.connect(phase, 100, stage)
+           stage_id = pipeline.attach(phase, 100, stage)
 
            # track() can be used to auto-unregister the phase when
            # the pipeline is removed.
            self.track(stage_id)
 
-.. note:: connect() was an unfortunate API choice and will likely be changed in
-          a future release to avoid collisions with signals.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]