diff options
| author | 1138-4EB <1138-4EB@users.noreply.github.com> | 2017-02-25 20:18:09 +0100 |
|---|---|---|
| committer | tgingold <tgingold@users.noreply.github.com> | 2017-12-10 12:02:05 +0100 |
| commit | e3047c70d11bcbe9998518733c2fcb61cb729ab5 (patch) | |
| tree | 75fa2731b7eebd77b3c0d44fc8bef34bdf065a15 /doc | |
| parent | 6871bbba1bdc4332cf68e1494e3c6f1615fefbcb (diff) | |
| download | ghdl-e3047c70d11bcbe9998518733c2fcb61cb729ab5.tar.gz ghdl-e3047c70d11bcbe9998518733c2fcb61cb729ab5.tar.bz2 ghdl-e3047c70d11bcbe9998518733c2fcb61cb729ab5.zip | |
Meta.rst added to changelog
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/changelog/Meta.rst | 18 | ||||
| -rw-r--r-- | doc/conf.py | 7 | ||||
| -rw-r--r-- | doc/getting/Building.rst | 2 |
3 files changed, 23 insertions, 4 deletions
diff --git a/doc/changelog/Meta.rst b/doc/changelog/Meta.rst new file mode 100644 index 000000000..4b86d7d32 --- /dev/null +++ b/doc/changelog/Meta.rst @@ -0,0 +1,18 @@ +.. _CHANGE:Roadmap: + +Meta +############ + +* Python snippet for Sphinx's `conf.py` to extract the current version number from Git (latest tag name). + + * :ghdlsharp:`200` + +* Reference :samp:`genindex.html` from the navigation bar. + + * :ghdlsharp:`200` + +* Create "parts" (LaTeX terminology / chapter headlines) in navigation bar. + + * :ghdlsharp:`200` + +* Ubuntu uses `dash` instead of `bash` when a shell script is run. As a result, some functionalities, such as arrays like :samp:`array[1]`, are not supported. Therefore, build scripts in `dist/linux` should not use those functionalities unless they are sourced in a `bash` shell. That is, :file:`tavis-ci.sh` uses arrays, since it is sourced in the Travis CI machine. But :file:`docker-buildtest.sh` and :file:`buildtest.sh` do not use any. The same applies to the scripts in `testsuite`.
\ No newline at end of file diff --git a/doc/conf.py b/doc/conf.py index 7a6ff7219..516275077 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -69,8 +69,8 @@ master_doc = 'index' # General information about the project. project = u'GHDL' -copyright = u'2015, Tristan Gingold' -author = u'Tristan Gingold' +copyright = u'2015-2017, Tristan Gingold and contributors' +author = u'Tristan Gingold and contributors' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -356,8 +356,9 @@ intersphinx_mapping = { # Sphinx.Ext.ExtLinks # ============================================================================== extlinks = { + 'ghdlsharp': ('https://github.com/tgingold/ghdl/issues/%s', '#'), 'ghdlissue': ('https://github.com/tgingold/ghdl/issues/%s', 'issue #'), 'ghdlpull': ('https://github.com/tgingold/ghdl/pull/%s', 'pull request #'), 'ghdlsrc': ('https://github.com/tgingold/ghdl/blob/master/src/%s', None), - 'wikipedia': ('https://en.wikipedia.org/wiki/%s', None) + 'wikipedia': ('https://en.wikipedia.org/wiki/%s', None) } diff --git a/doc/getting/Building.rst b/doc/getting/Building.rst index 9c357b476..64e72bccb 100644 --- a/doc/getting/Building.rst +++ b/doc/getting/Building.rst @@ -105,7 +105,7 @@ LLVM backend GNU/Linux ---------------- -You need to install LLVM (usually depends on :samp:`libedit`). The supported versions are 3.5 till 3.9, but debugging is only supported with LLVM 3.5. +You need to install LLVM (usually depends on :samp:`libedit`, see :ghdlsharp`29`). The supported versions are 3.5 till 3.9, but debugging is only supported with LLVM 3.5. - First configure GHDL with the proper arg :samp:`./configure --with-llvm-config`. If :samp:`llvm-config` is not in your path, you can specify it: :samp:`./configure --with-llvm-config=LLVM_INSTALL/bin/llvm-config`. |