fdo-mirrors/libinput
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libinput.git synced 2026-05-04 23:28:00 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: drop the git version into the documentation

Browse source 
The libinput/doc/latest is now built automatically from git, so it's good to
have a reference to show which commit it was being built from. Add a section
to the readme with git commit information that is replaced by meson.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
Peter Hutterer 2018-07-05 12:17:26 +10:00
parent d2cd727c9b
commit ff15bfd99f
3 changed files with 17 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -90,3 +90,8 @@ libinput is licensed under the MIT license.
See the [COPYING](https://gitlab.freedesktop.org/libinput/libinput/tree/master/COPYING) See the [COPYING](https://gitlab.freedesktop.org/libinput/libinput/tree/master/COPYING)
file for the full license information. file for the full license information.
About
-----
Documentation generated by from git commit [__GIT_VERSION__](https://gitlab.freedesktop.org/libinput/libinput/commit/__GIT_VERSION__)

2
doc/libinput.doxygen.in
View file

@ -28,4 +28,4 @@ HTML_FOOTER = "@top_srcdir@/doc/style/footer.html"
HTML_EXTRA_STYLESHEET = "@top_srcdir@/doc/style/bootstrap.css" \ HTML_EXTRA_STYLESHEET = "@top_srcdir@/doc/style/bootstrap.css" \
"@top_srcdir@/doc/style/customdoxygen.css" \ "@top_srcdir@/doc/style/customdoxygen.css" \
"@top_srcdir@/doc/style/libinputdoxygen.css" "@top_srcdir@/doc/style/libinputdoxygen.css"
USE_MDFILE_AS_MAINPAGE = "@top_srcdir@/README.md" USE_MDFILE_AS_MAINPAGE = @README_MD@

13
meson.build
View file

@ -340,6 +340,12 @@ if get_option('documentation')
error('Graphviz dot needs to be at least version 2.26 (have @0@)'.format(dot_version)) error('Graphviz dot needs to be at least version 2.26 (have @0@)'.format(dot_version))
endif endif
readme = vcs_tag(command : ['git', 'log', '-1', '--format=%h'],
fallback : 'unknown',
input : 'README.md',
output : 'README.md',
replace_string: '__GIT_VERSION__')
src_doxygen = files( src_doxygen = files(
# source files # source files
'src/libinput.h', 'src/libinput.h',
@ -417,7 +423,6 @@ if get_option('documentation')
'doc/style/customdoxygen.css', 'doc/style/customdoxygen.css',
'doc/style/bootstrap.css', 'doc/style/bootstrap.css',
'doc/style/libinputdoxygen.css', 'doc/style/libinputdoxygen.css',
'README.md'
) )
# doxygen expects a space-separated list of input files in its # doxygen expects a space-separated list of input files in its
@ -428,18 +433,22 @@ if get_option('documentation')
doxy_input_files += [join_paths(meson.source_root(), '@0@'.format(f))] doxy_input_files += [join_paths(meson.source_root(), '@0@'.format(f))]
endforeach endforeach
doxy_input_files += [readme.full_path()]
doc_config = configuration_data() doc_config = configuration_data()
doc_config.set('PACKAGE_NAME', meson.project_name()) doc_config.set('PACKAGE_NAME', meson.project_name())
doc_config.set('PACKAGE_VERSION', meson.project_version()) doc_config.set('PACKAGE_VERSION', meson.project_version())
doc_config.set('top_srcdir', meson.source_root()) doc_config.set('top_srcdir', meson.source_root())
doc_config.set('INPUT', ' '.join(doxy_input_files)) doc_config.set('INPUT', ' '.join(doxy_input_files))
doc_config.set('README_MD', readme.full_path())
doxyfile = configure_file(input : 'doc/libinput.doxygen.in', doxyfile = configure_file(input : 'doc/libinput.doxygen.in',
output : 'libinput.doxygen', output : 'libinput.doxygen',
configuration : doc_config, configuration : doc_config,
install : false) install : false)
custom_target('doxygen', custom_target('doxygen',
input : [ doxyfile ] + src_doxygen, input : [ doxyfile, readme ] + src_doxygen,
output : [ 'Documentation' ], output : [ 'Documentation' ],
command : [ doxygen, doxyfile ], command : [ doxygen, doxyfile ],
install : false, install : false,