refactor(tofs): move “files_switch” macro to “libtofs.jinja”

BREAKING CHANGE: every formula writer will need to change the import to use this new version. * template/libtofs.jinja: provides the “files_switch” macro. * docs/TOFS_pattern.rst: update documentation to use the new path. * template/config/clean.sls: change import from “macros.jinja” to “libtofs.jinja”. * template/config/file.sls: ditoo.
saltstack-formulas · Mar 21, 2019 · da7e692 · da7e692
1 parent 6d2140f
commit da7e692
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/docs/TOFS_pattern.rst b/docs/TOFS_pattern.rst
@@ -308,7 +308,7 @@ We can simplify the ``conf.sls`` with the new ``files_switch`` macro to use in t
 
    {%- set tplroot = tpldir.split('/')[0] %}
    {%- from 'ntp/map.jinja' import ntp with context %}
-   {%- from 'ntp/macros.jinja' import files_switch %}
+   {%- from 'ntp/libtofs.jinja' import files_switch %}
 
    Configure NTP:
      file.managed:
@@ -327,10 +327,10 @@ We can simplify the ``conf.sls`` with the new ``files_switch`` macro to use in t
 * This uses ``config.get``, searching for ``ntp:tofs:source_files:Configure NTP`` to determine the list of template files to use.
 * If this does not yield any results, the default of ``['/etc/ntp.conf.jinja']`` will be used.
 
-In ``macros.jinja``, we define this new macro ``files_switch``.
+In ``libtofs.jinja``, we define this new macro ``files_switch``.
 
-.. literalinclude:: ../template/macros.jinja
-   :caption: /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/macros.jinja
+.. literalinclude:: ../template/libtofs.jinja
+   :caption: /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/libtofs.jinja
    :language: jinja
 
 How to customise the ``source`` further

diff --git a/template/config/clean.sls b/template/config/clean.sls
@@ -5,7 +5,7 @@
 {%- set tplroot = tpldir.split('/')[0] %}
 {%- set sls_service_clean = tplroot ~ '.service.clean' %}
 {%- from tplroot ~ "/map.jinja" import template with context %}
-{%- from tplroot ~ "/macros.jinja" import files_switch with context %}
+{%- from tplroot ~ "/libtofs.jinja" import files_switch with context %}
 
 include:
   - {{ sls_service_clean }}

diff --git a/template/config/file.sls b/template/config/file.sls
@@ -5,7 +5,7 @@
 {%- set tplroot = tpldir.split('/')[0] %}
 {%- set sls_package_install = tplroot ~ '.package.install' %}
 {%- from tplroot ~ "/map.jinja" import template with context %}
-{%- from tplroot ~ "/macros.jinja" import files_switch with context %}
+{%- from tplroot ~ "/libtofs.jinja" import files_switch with context %}
 
 include:
   - {{ sls_package_install }}

diff --git a/template/macros.jinja → template/libtofs.jinja b/template/macros.jinja → template/libtofs.jinja