From 8386baed1170d29c54a5babaa6b5084ee8593d6c Mon Sep 17 00:00:00 2001 From: Radovan Bast Date: Sun, 11 Jun 2017 18:44:16 +0200 Subject: [PATCH] document language specification --- doc/developers/configuration.rst | 10 ++++++++-- doc/developers/example.rst | 4 ++++ 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/doc/developers/configuration.rst b/doc/developers/configuration.rst index 084a6b8..13df7b8 100644 --- a/doc/developers/configuration.rst +++ b/doc/developers/configuration.rst @@ -12,6 +12,11 @@ below:: min_cmake_version: 2.8 + language: + - Fortran + - C + - CXX + url_root: https://github.com/coderefinery/autocmake/raw/master/ modules: @@ -45,7 +50,7 @@ Name and order of sections First we define the project name (here "numgrid"). This section has to be there and it has to be called "project" (but it does not have to be on top). -We also have to define ``min_cmake_version``. +We also have to define ``min_cmake_version`` as well as set the supported language(s). The definition ``url_root`` is an interpolation (see :ref:`interpolation`) and we use it to avoid retyping the same line over and over and to be able to @@ -69,6 +74,7 @@ As a minimal example we take an ``autocmake.yml`` which only contains:: name: minime min_cmake_version: 2.8 + language: C If you don't have the ``update.py`` script yet, you need to fetch it from the web:: @@ -105,7 +111,7 @@ Excellent. Here is the generated ``CMakeLists.txt``:: cmake_minimum_required(VERSION 2.8 FATAL_ERROR) # project name - project(minime) + project(minime C) # do not rebuild if rules (compiler flags) change set(CMAKE_SKIP_RULE_DEPENDENCY TRUE) diff --git a/doc/developers/example.rst b/doc/developers/example.rst index 4d83150..4d6f21d 100644 --- a/doc/developers/example.rst +++ b/doc/developers/example.rst @@ -56,6 +56,10 @@ Now we edit ``cmake/autocmake.yml`` to look like this:: min_cmake_version: 2.8 + language: + - Fortran + - C + url_root: https://github.com/coderefinery/autocmake/raw/master/ modules: