Mercurial > repos > other > Puppet

comparison modules/inifile/README.md @ 478:adf6fe9bbc17

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update Puppet modules to latest versions
author IBBoard <dev@ibboard.co.uk>
date Thu, 29 Aug 2024 18:47:29 +0100
parents 3fce34f642f1
children
comparison
equal deleted inserted replaced
477:21f6add30502 478:adf6fe9bbc17
1 # inifile 1 # inifile
2
3 [![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-inifile.png?branch=main)](https://travis-ci.org/puppetlabs/puppetlabs-inifile)
4 2
5 #### Table of Contents 3 #### Table of Contents
6 4
7 1. [Overview](#overview) 5 1. [Overview](#overview)
8 1. [Module Description - What the module does and why it is useful](#module-description) 6 1. [Module Description - What the module does and why it is useful](#module-description)
9 1. [Setup - The basics of getting started with inifile module](#setup) 7 1. [Setup - The basics of getting started with inifile module](#setup)
10 1. [Usage - Configuration options and additional functionality](#usage) 8 1. [Usage - Configuration options and additional functionality](#usage)
11 1. [Reference - An under-the-hood peek at what the module is doing and how](#reference) 9 1. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
12 1. [Limitations - OS compatibility, etc.](#limitations) 10 1. [Limitations - OS compatibility, etc.](#limitations)
11 1. [License](#license)
13 1. [Development - Guide for contributing to the module](#development) 12 1. [Development - Guide for contributing to the module](#development)
14 13
15 <a id="overview"></a> 14 <a id="overview"></a>
16 ## Overview 15 ## Overview
17 16
293 <a id="reference"></a> 292 <a id="reference"></a>
294 ## Reference 293 ## Reference
295 See [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-inifile/blob/main/REFERENCE.md) 294 See [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-inifile/blob/main/REFERENCE.md)
296 295
297 <a id="limitations"></a> 296 <a id="limitations"></a>
297
298 ## Limitations 298 ## Limitations
299 299
300 ### Supported operating systems
301
300 For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-inifile/blob/main/metadata.json) 302 For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-inifile/blob/main/metadata.json)
303
304 ### create_ini_settings
305
306 When using inifile::create_ini_settings it’s worth noting that namespace tags will not be applied to the resource. If you need these namespace tags we advise using the standard ini_setting resource.
307
308 For more information about resource tags, please see [this article](https://puppet.com/docs/puppet/7/lang_tags.html#lang_tags-assigning-tags-to-resources).
309
310 <a id="license"></a>
311 ## License
312
313 This codebase is licensed under the Apache2.0 licensing, however due to the nature of the codebase the open source dependencies may also use a combination of [AGPL](https://opensource.org/license/agpl-v3/), [BSD-2](https://opensource.org/license/bsd-2-clause/), [BSD-3](https://opensource.org/license/bsd-3-clause/), [GPL2.0](https://opensource.org/license/gpl-2-0/), [LGPL](https://opensource.org/license/lgpl-3-0/), [MIT](https://opensource.org/license/mit/) and [MPL](https://opensource.org/license/mpl-2-0/) Licensing.
301 314
302 <a id="development"></a> 315 <a id="development"></a>
303 ## Development 316 ## Development
304 317
305 We are experimenting with a new tool for running acceptance tests. It's name is [puppet_litmus](https://github.com/puppetlabs/puppet_litmus) this replaces beaker as the test runner. To run the acceptance tests follow the instructions [here](https://github.com/puppetlabs/puppet_litmus/wiki/Tutorial:-use-Litmus-to-execute-acceptance-tests-with-a-sample-module-(MoTD)#install-the-necessary-gems-for-the-module). 318 We are experimenting with a new tool for running acceptance tests. It's name is [puppet_litmus](https://github.com/puppetlabs/puppet_litmus) this replaces beaker as the test runner. To run the acceptance tests follow the instructions [here](https://github.com/puppetlabs/puppet_litmus/wiki/Tutorial:-use-Litmus-to-execute-acceptance-tests-with-a-sample-module-(MoTD)#install-the-necessary-gems-for-the-module).