Skip to content

Commit

Permalink
Trim plugins content
Browse files Browse the repository at this point in the history
  • Loading branch information
caldav committed Aug 23, 2016
1 parent 5c7590b commit ae006ae
Show file tree
Hide file tree
Showing 20 changed files with 21 additions and 94 deletions.
4 changes: 0 additions & 4 deletions reference/plugins/ant.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,4 @@ The ant plugin is useful for ant based parts.
The ant build system is commonly used to build Java projects.
The plugin requires a build.xml in the root of the source tree.

This plugin uses the common plugin keywords as well as those for "sources".
For more information check the 'plugins' topic for the former and the
'sources' topic for the latter.

[Examples](https://github.com/search?o=desc&q=filename%3Asnapcraft.yaml+%22plugin%3A+ant%22+&s=indexed&type=Code&utf8=%E2%9C%93)
4 changes: 0 additions & 4 deletions reference/plugins/autotools.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ Autotools based projects are the ones that have the usual
The plugin tries to build using ./configure first, if it is not there
it will run ./autogen and if autogen is not there it will run autoreconf.

This plugin uses the common plugin keywords as well as those for "sources".
For more information check the 'plugins' topic for the former and the
'sources' topic for the latter.

In addition, this plugin uses the following plugin-specific keywords:

- configflags:
Expand Down
6 changes: 1 addition & 5 deletions reference/plugins/catkin.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,7 @@ title: "The catkin plugin"

The catkin plugin is useful for building ROS parts.

This plugin uses the common plugin keywords as well as those for "sources".
For more information check the 'plugins' topic for the former and the
'sources' topic for the latter.

Additionally, this plugin uses the following plugin-specific keywords:
This plugin uses the following plugin-specific keywords:

- catkin-packages:
(list of strings)
Expand Down
6 changes: 1 addition & 5 deletions reference/plugins/cmake.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,7 @@ The cmake plugin is useful for building cmake based parts.
These are projects that have a CMakeLists.txt that drives the build.
The plugin requires a CMakeLists.txt in the root of the source tree.

This plugin uses the common plugin keywords as well as those for "sources".
For more information check the 'plugins' topic for the former and the
'sources' topic for the latter.

Additionally, this plugin uses the following plugin-specific keywords:
This plugin uses the following plugin-specific keywords:

- configflags:
(list of strings)
Expand Down
6 changes: 1 addition & 5 deletions reference/plugins/copy.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,7 @@ The copy plugin is useful for assets or other sources with no build system.

This plugin is DEPRECATED in favor of the `dump` plugin.

This plugin uses the common plugin keywords as well as those for 'sources'
(though the 'source' keyword is optional). For more information check the
'plugins' topic for the former and the 'sources' topic for the latter.

Additionally, this plugin uses the following plugin-specific keywords:
This plugin uses the following plugin-specific keywords:

- files:
(object)
Expand Down
6 changes: 1 addition & 5 deletions reference/plugins/dump.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,7 @@
title: "The dump plugin"
---

This plugin just dumps the content from a specified source.

This plugin uses the common plugin keywords as well as those for 'sources'.
For more information check the 'plugins' topic for the former and the
'sources' topic for the latter.
This plugin just dumps the content from a specified `source`.

In the cases where dumping the content needs some mangling or organizing
one would take advantage of the core functionalities available to plugins
Expand Down
9 changes: 1 addition & 8 deletions reference/plugins/go.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,7 @@ title: "The go plugin"

The go plugin can be used for go projects using `go get`.

This plugin uses the common plugin keywords, for more information check the
'plugins' topic.

This plugin uses the common plugin keywords as well as those for "sources".
For more information check the 'plugins' topic for the former and the
'sources' topic for the latter.

Additionally, this plugin uses the following plugin-specific keywords:
This plugin uses the following plugin-specific keywords:

- go-packages:
(list of strings)
Expand Down
6 changes: 1 addition & 5 deletions reference/plugins/godeps.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,7 @@ These projects have a file containing information about the project's
dependencies. This file is typically called "dependencies.tsv," but may be
named anything.

This plugin uses the common plugin keywords as well as those for "sources".
For more information check the 'plugins' topic for the former and the
'sources' topic for the latter.

Additionally, this plugin uses the following plugin-specific keywords:
This plugin uses the following plugin-specific keywords:

- godeps-file:
(string)
Expand Down
7 changes: 2 additions & 5 deletions reference/plugins/gradle.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,10 @@ title: "The gradle plugin"
This plugin is useful for building parts that use gradle.

The gradle build system is commonly used to build Java projects.
The plugin requires a pom.xml in the root of the source tree.

This plugin uses the common plugin keywords as well as those for "sources".
For more information check the 'plugins' topic for the former and the
'sources' topic for the latter.
The plugin requires a pom.xml in the root of the source tree.

Additionally, this plugin uses the following plugin-specific keywords:
This plugin uses the following plugin-specific keywords:

- gradle-options:
(list of strings)
Expand Down
6 changes: 1 addition & 5 deletions reference/plugins/gulp.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,7 @@ This plugin is used for gulp.js, the streaming build system.
The plugin uses gulp to drive the build. It requires a gulpfile.js in
the root of the source.

This plugin uses the common plugin keywords as well as those for "sources".
For more information check the 'plugins' topic for the former and the
'sources' topic for the latter.

Additionally, this plugin uses the following plugin-specific keywords:
This plugin uses the following plugin-specific keywords:

- gulp-tasks:
(list)
Expand Down
10 changes: 3 additions & 7 deletions reference/plugins/make.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,10 @@ The make plugin is useful for building make based parts.
Make based projects are projects that have a Makefile that drives the
build.

This plugin always runs 'make' followed by 'make install', except when
the 'artifacts' keyword is used.
This plugin always runs `make` followed by `make install`, except when
the `artifacts` keyword is used.

This plugin uses the common plugin keywords as well as those for "sources".
For more information check the 'plugins' topic for the former and the
'sources' topic for the latter.

Additionally, this plugin uses the following plugin-specific keywords:
This plugin uses the following plugin-specific keywords:

- artifacts:
(list)
Expand Down
6 changes: 1 addition & 5 deletions reference/plugins/maven.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,7 @@ This plugin is useful for building parts that use maven.
The maven build system is commonly used to build Java projects.
The plugin requires a pom.xml in the root of the source tree.

This plugin uses the common plugin keywords as well as those for "sources".
For more information check the 'plugins' topic for the former and the
'sources' topic for the latter.

Additionally, this plugin uses the following plugin-specific keywords:
This plugin uses the following plugin-specific keywords:

- maven-options:
(list of strings)
Expand Down
2 changes: 1 addition & 1 deletion reference/plugins/nil.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ title: "The nil plugin"
The nil plugin is useful for parts with no source.

Using this, parts can be defined purely by utilizing properties automatically
included by Snapcraft, e.g. stage-packages.
included by Snapcraft, e.g. `stage-packages`.

[Examples](https://github.com/search?o=desc&q=filename%3Asnapcraft.yaml+%22plugin%3A+nil%22+&s=indexed&type=Code&utf8=%E2%9C%93)
6 changes: 1 addition & 5 deletions reference/plugins/nodejs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,7 @@ The nodejs plugin is useful for node/npm based parts.
The plugin uses node to install dependencies from `package.json`. It
also sets up binaries defined in `package.json` into the `PATH`.

This plugin uses the common plugin keywords as well as those for "sources".
For more information check the 'plugins' topic for the former and the
'sources' topic for the latter.

Additionally, this plugin uses the following plugin-specific keywords:
This plugin uses the following plugin-specific keywords:

- node-packages:
(list)
Expand Down
6 changes: 1 addition & 5 deletions reference/plugins/python2.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,7 @@ want to do:
- build a python project that has a setup.py
- install sources straight from pip

This plugin uses the common plugin keywords as well as those for "sources".
For more information check the 'plugins' topic for the former and the
'sources' topic for the latter.

Additionally, this plugin uses the following plugin-specific keywords:
This plugin uses the following plugin-specific keywords:

- requirements:
(string)
Expand Down
6 changes: 1 addition & 5 deletions reference/plugins/python3.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,7 @@ want to do:
- build a python project that has a setup.py
- install sources straight from pip

This plugin uses the common plugin keywords as well as those for "sources".
For more information check the 'plugins' topic for the former and the
'sources' topic for the latter.

Additionally, this plugin uses the following plugin-specific keywords:
This plugin uses the following plugin-specific keywords:

- requirements:
(string)
Expand Down
6 changes: 1 addition & 5 deletions reference/plugins/qmake.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,7 @@ The qmake plugin is useful for building qmake-based parts.

These are projects that are built using .pro files.

This plugin uses the common plugin keywords as well as those for "sources".
For more information check the 'plugins' topic for the former and the
'sources' topic for the latter.

Additionally, this plugin uses the following plugin-specific keywords:
This plugin uses the following plugin-specific keywords:

- options:
(list of strings)
Expand Down
6 changes: 1 addition & 5 deletions reference/plugins/rust.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,7 @@ This rust plugin is useful for building rust based parts.

Rust uses cargo to drive the build.

This plugin uses the common plugin keywords as well as those for "sources".
For more information check the 'plugins' topic for the former and the
'sources' topic for the latter.

Additionally, this plugin uses the following plugin-specific keywords:
This plugin uses the following plugin-specific keywords:

- rust-channel
(string)
Expand Down
6 changes: 1 addition & 5 deletions reference/plugins/scons.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,7 @@ The scons plugin is useful for building parts that build with scons.

These are projects that have a SConstruct that drives the build.

This plugin uses the common plugin keywords as well as those for "sources".
For more information check the 'plugins' topic for the former and the
'sources' topic for the latter.

Additionally, this plugin uses the following plugin-specific keywords:
This plugin uses the following plugin-specific keywords:

- scons-options:
(list of strings)
Expand Down
1 change: 1 addition & 0 deletions reference/plugins/tar-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ title: "The tar-content plugin"
---

The plugin has no documentation

[Examples](https://github.com/search?o=desc&q=filename%3Asnapcraft.yaml+%22plugin%3A+tar-content%22+&s=indexed&type=Code&utf8=%E2%9C%93)

0 comments on commit ae006ae

Please sign in to comment.