[Notes] [Git][BuildStream/buildstream][willsalmon/simpleOutSource] Extended the Documentation to cover out of source builds



Title: GitLab

Will Salmon pushed to branch willsalmon/simpleOutSource at BuildStream / buildstream

Commits:

2 changed files:

Changes:

  • buildstream/buildelement.py
    ... ... @@ -23,6 +23,40 @@ BuildElement - Abstract class for build elements
    23 23
     The BuildElement class is a convenience element one can derive from for
    
    24 24
     implementing the most common case of element.
    
    25 25
     
    
    26
    +Built-in functionality
    
    27
    +----------------------
    
    28
    +
    
    29
    +The BuildElement base class provides built in functionality that could be overridden by the
    
    30
    +individual plugins.
    
    31
    +
    
    32
    +This section will give a brief summary of how some of the common features work, some of them or the variables they
    
    33
    +use will be further detailed in the following sections.
    
    34
    +
    
    35
    +* Location for running commands
    
    36
    +
    
    37
    + The ``command-subdir`` variable sets where the build commands will be executed, if the directory dose not exist it
    
    38
    + will be created, it is defined relative to the buildroot.
    
    39
    +
    
    40
    +* Location for configuring the project
    
    41
    +
    
    42
    + The ``conf-root`` is defined by default as ``.`` and is the location that specific build element can use to look
    
    43
    + for build configuration files, currently autotools and cmake use this.
    
    44
    +
    
    45
    + The configuration commands are run in ``command-subdir`` and by default ``conf-root`` is ``.`` so if
    
    46
    + ``conf-root`` is not set the configuration files in ``command-subdir`` will be used.
    
    47
    +
    
    48
    + By setting ``conf-root`` to ``"%{build-root}/Source/conf_location"`` and your source elements ``directory`` variable
    
    49
    + to ``Source`` then the configuration files in the directory ``conf_location`` with in your Source will be used.
    
    50
    + However the location where your configuration command will be run will still be wherever you set your
    
    51
    + ``command-subdir`` to be.
    
    52
    +
    
    53
    + The ``conf-root`` variable is available since :ref:`format version 17 <project_format_version>` 
    
    54
    +
    
    55
    +* Install Location
    
    56
    +
    
    57
    +  You should not change the ``install-root`` variable as it is a special writeable location in the sandbox but it is
    
    58
    +  useful when writing custom install instructions as it may need to be supplied as the ``DESTDIR``, please see the
    
    59
    +  cmake build element for example.
    
    26 60
     
    
    27 61
     Abstract method implementations
    
    28 62
     -------------------------------
    

  • buildstream/source.py
    ... ... @@ -20,6 +20,19 @@
    20 20
     Source - Base source class
    
    21 21
     ==========================
    
    22 22
     
    
    23
    +Built-in functionality
    
    24
    +----------------------
    
    25
    +
    
    26
    +The Source base class provides built in functionality that could be overridden by the
    
    27
    +individual plugins.
    
    28
    +
    
    29
    +* Directory
    
    30
    +
    
    31
    +  The ``directory`` variable can be set for all sources of a type in project.conf
    
    32
    +  or per source within a element.
    
    33
    +
    
    34
    +  This sets the location with in the build root that the content of the source will be
    
    35
    +  loaded in to. If the location dose not exist it will be created.
    
    23 36
     
    
    24 37
     .. _core_source_abstract_methods:
    
    25 38
     
    



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