summaryrefslogtreecommitdiff
path: root/solenv/bin/mkdocs.sh
AgeCommit message (Collapse)Author
2024-01-22use portable "command -v" to detect installed programs, part 2Eli Schwartz
The "which" utility is not guaranteed to be installed either, and if it is, its behavior is not portable either. This means that when various programs are installed, the `which` check will report a fatal error because the which tool did not exist and the shell returned a nonzero status when attempting to fork+exec. If it did exist, it might not be an implementation of `which` that returns nonzero when commands do not exist. The general scripting suggestion is to use the "command -v" shell builtin; this is required to exist in all POSIX 2008 compliant shells, and is thus guaranteed to work everywhere. For some in-depth discussions on the topic, see: - https://mywiki.wooledge.org/BashFAQ/081 - https://unix.stackexchange.com/questions/85249/why-not-use-which-what-to-use-then/85250#85250 Examples of open-source shells likely to be installed as /bin/sh on Linux, which implement the 15-year-old standard: ash, bash, busybox, dash, ksh, mksh and zsh. This commit updates the build system to configure and build correctly on systems without `which`. Change-Id: I23dbde5c7f104dd610fd5f78c82bf9a7d0cc1930 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/160663 Tested-by: Jenkins Tested-by: Ilmari Lauhakangas <ilmari.lauhakangas@libreoffice.org> Reviewed-by: Ilmari Lauhakangas <ilmari.lauhakangas@libreoffice.org>
2021-11-04Change git.freedesktop.org -> git.libreoffice.orgHossein
Replace git.freedesktop.org with git.libreoffice.org in the docs gernerating scripts. The output will be visible at the https://docs.libreoffice.org or the local docs folder. This completes the "Use LO repo for mkdocs git link" patch e62c4241093409583c913165ddc1e4c300c6218c Change-Id: Id38d86821cd1c4edb16edd760087c8361e221de3 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/124674 Tested-by: Jenkins Tested-by: Ilmari Lauhakangas <ilmari.lauhakangas@libreoffice.org> Reviewed-by: Ilmari Lauhakangas <ilmari.lauhakangas@libreoffice.org>
2021-10-26Use LO repo for mkdocs git linksHossein
* Use git.libreoffice.org instead of cgit.freedesktop.org for the git links generated by mkdocs scripts Change-Id: Iac6e9ea1b73dcd0155786798c0ec162865299ada Reviewed-on: https://gerrit.libreoffice.org/c/core/+/124186 Tested-by: Jenkins Tested-by: Ilmari Lauhakangas <ilmari.lauhakangas@libreoffice.org> Reviewed-by: Ilmari Lauhakangas <ilmari.lauhakangas@libreoffice.org>
2021-04-14Fix problems with LibreOffice document generation (local and portal)Hossein
* Fixed problems with LibreOffice local document generation script (mkdocs.sh) by interpreting backslash escapes when generating module links using "echo -e" and using double quotes around Markdown generated text. The result is placed at docs/ folder. * Fixed problems with LibreOffice portal document generation script (mkdocs_portal.sh and mkonedoc.sh) by doing above fixes and also adding code from the local document generation script. The result is placed at https://docs.libreoffice.org/ * Only the README.md files are processed, and not README* or readme.txt* * Fixed redmine #3515 "Remove non-necessary subfolders from docs.libreoffice.org" by excluding these 10 folders: "autom4te.cache dictionaries docs helpcompiler helpcontent2 include instdir lo translations workdir" Change-Id: Id230872b8583a575bfeb6fc77cc9f96d5982908f Reviewed-on: https://gerrit.libreoffice.org/c/core/+/113773 Tested-by: Jenkins Reviewed-by: Thorsten Behrens <thorsten.behrens@allotropia.de>
2019-08-05Fix typosAndrea Gelmini
Change-Id: I66d48c809b263835016571772ce2ee529c16b8f4 Reviewed-on: https://gerrit.libreoffice.org/76960 Tested-by: Jenkins Reviewed-by: Julien Nabet <serval2412@yahoo.fr>
2018-08-30solenv: fix markdown issues in mkdocs.shMichael Stahl
- Fedora 28 has python3-markdown2 package containing /usr/bin/markdown2-3 - the "alias" doesn't work at all because it's not exported to the sub-shell in $(markdown) so use variable instead Change-Id: Icf2af1e66750269e0660f3897a91734cadf5d978
2018-04-16Use https instead of httpGulsah Kose
Use "https://cgit.freedesktop.org/libreoffice/core" instead of "http://cgit.freedesktop.org/libreoffice/core" Change-Id: Ic7248eeb2a9452da7236eeee08414a77714dd234 Signed-off-by: Gulsah Kose <gulsah.1004@gmail.com> Reviewed-on: https://gerrit.libreoffice.org/52926 Tested-by: Jenkins <ci@libreoffice.org> Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
2017-06-03solenv: typo in mkdocs.sh scriptChris Sherlock
Change-Id: I446826c9f0b07b2d44321c1a1e68ea29c6d68daa
2017-05-28solenv: include all global headers needed by the sal moduleChris Sherlock
The sal module is a bit of a special case in that it actually takes headers from three locations: include/sal/, include/osl/ and include/rtl. We need to cater for this in the mkdocs.sh script. Change-Id: I846dbfe948d86a6ad719bba263165ac251dbf9bc Reviewed-on: https://gerrit.libreoffice.org/38099 Reviewed-by: Chris Sherlock <chris.sherlock79@gmail.com> Tested-by: Chris Sherlock <chris.sherlock79@gmail.com>
2017-05-20mkdocs.sh: alias cmd variant to canonical nameThorsten Behrens
Otherwise being flexible during checking of required commands is a bit pointless. Change-Id: I9a6e283c816a87f35ce7913c294eaacb7da9a95b
2017-05-20mkdocs.sh: support more than one markdown converter binaryThorsten Behrens
Change-Id: Ib3f79dd53e96c8f6d40c9c6614db5c672f24ba97
2017-05-19Support markdown format for module README file.Kohei Yoshida
Now you can author a module README file in markdown format. To distinguish it from the existing format, you need to save it as README.md then it'll be treated as a markdown file. Change-Id: Iebf3ae32608d348768b2da7157d122954a7b72f7
2017-05-19Convert tabs to spaces.Kohei Yoshida
Change-Id: I4c718740bebbde123aa0aa0cbae53778d840055b
2016-02-23quiet down mkdocs.sh on consoleNorbert Thiebaud
Change-Id: Ibf1cc6dcec3909f8aa639e52a13c2b8641c28628
2016-02-18solenv: use html files for doxygen, not xhtml filesChris Sherlock
Change-Id: I2dd6e80698818f2a02e63cf91a72fe8c08b2265c Reviewed-on: https://gerrit.libreoffice.org/22453 Tested-by: Jenkins <ci@libreoffice.org> Reviewed-by: Chris Sherlock <chris.sherlock79@gmail.com>
2016-02-05solenv: fix mkdocs.sh to take into account projects with no inc dirChris Sherlock
Change-Id: I959279c11f0ae5f372936ee3db605716cab37c21
2016-02-04accessibility: fix rest of doxygen errorsChris Sherlock
I've changed the doxygen generation script to generate an xhtml page, and it uses SVG diagrams now. Change-Id: I876795675ae9ebcfec6f7fe5edc43c9d2e4964d3
2016-01-08solenv: if module is vcl, then include filter directories in doxygen includeChris Sherlock
Change-Id: I79610ab5c9eb3812035d9d2c5f8ce1508451cd60 Reviewed-on: https://gerrit.libreoffice.org/21251 Reviewed-by: Chris Sherlock <chris.sherlock79@gmail.com> Tested-by: Chris Sherlock <chris.sherlock79@gmail.com>
2016-01-08solenv: allow mkdocs.sh to index selected modules onlyChris Sherlock
I've added a test of the environment variable $INPUT_PROJECTS, if this exists then use the list of modules specified. If it doesn't exist then the script runs as normal and processes all modules. Change-Id: Ibafb826fa20a56d921e5ffacb0f5101ed936ae55
2014-09-26Use multi-column layout and correct header colourPhilipp Weissenbacher
Also fixed some tab indents Change-Id: If2e4301d2199e0a72c8d859231430c1982fd0fc0 Reviewed-on: https://gerrit.libreoffice.org/11649 Reviewed-by: Caolán McNamara <caolanm@redhat.com> Tested-by: Caolán McNamara <caolanm@redhat.com>
2014-01-27Fix include path error in mkdocs.sh introduced in 247cd3381745Chris Sherlock
Unfortunately in commit 247cd33817457789645827a52d79a1876b9760a3 I mistakenly included the directories wrongly. This fixes this. Change-Id: I91193321d1264985eab4865ca05adeab96401b2f Reviewed-on: https://gerrit.libreoffice.org/7669 Reviewed-by: Markus Mohrhard <markus.mohrhard@googlemail.com> Tested-by: Markus Mohrhard <markus.mohrhard@googlemail.com>
2014-01-26fdo#74013 make makedocs.sh look in correct project header directoriesChris Sherlock
At the moment, project headers can be either in $PROJECT/inc or include/$PROJECT. I believe it is possible for them to be in both locations. Unfortunately, we check for both areas, and doxygen spits out an error. Fix is to check if the header directory exists, only use it if it does. Change-Id: I2e59d8ce0028c20b7d239dcc6e07792edf7078d1 Reviewed-on: https://gerrit.libreoffice.org/7631 Reviewed-by: Miklos Vajna <vmiklos@collabora.co.uk> Tested-by: Miklos Vajna <vmiklos@collabora.co.uk>
2013-11-07remove INPATH and PROEXTMichael Stahl
- WORKDIR path is just workdir - INSTDIR path is just instdir - WORKDIR_FOR_BUILD is workdir_for_build - INSTDIR_FOR_BUILD is instdir_for_build - replace other usage of INPATH by combination of OS and CPUNAME Change-Id: Ie398387ebd82a968ec2605f2103c55b43a231482 Reviewed-on: https://gerrit.libreoffice.org/6601 Reviewed-by: Tor Lillqvist <tml@collabora.com> Tested-by: Tor Lillqvist <tml@collabora.com> Reviewed-by: Michael Stahl <mstahl@redhat.com>
2013-05-13mkdocs.sh: adapt to global include dirMiklos Vajna
Change-Id: Ieacf702649fd9581213612454eba67ba38f8cc13
2013-03-21fix mkdocs.shPeter Foley
Change-Id: Ia77605732bb5112a69289997db5d1c4a4b694594
2013-02-18Add sal to doxygen docs, fix build order.Thorsten Behrens
Change-Id: I9f06304f20b464b70fd6661c9ae1a0d21c84f273
2012-11-12re-base on ALv2 code. Includes:Michael Meeks
Patches contributed by Pedro Giffuni: Avoid some uses of non portable #!/bin/bash in shell scripts. http://svn.apache.org/viewvc?view=revision&revision=1235297 Reduce the dependencies on non standard GNU copy. http://svn.apache.org/viewvc?view=revision&revision=1238684 Correct /usr/bin/env path. http://svn.apache.org/viewvc?view=revision&revision=1235619 Complex Toolbar Controls Extension from the SDK Patches contributed by Ariel Constenla-Haile http://svn.apache.org/viewvc?view=revision&revision=1190390 i118615 - make epm more verbose http://svn.apache.org/viewvc?view=revision&revision=1204288 Patches contributed by Mathias Bauer (and others) gnumake4 work variously http://svn.apache.org/viewvc?view=revision&revision=1394707 http://svn.apache.org/viewvc?view=revision&revision=1394326 Patches contributed by Juergen Schmidt: jsc341: i117327: take care if no dependency node in current description exists, create one http://svn.apache.org/viewvc?view=revision&revision=1172101 jsc341: i117327: add extra extension dependency check http://svn.apache.org/viewvc?view=revision&revision=1172098 make initial branding changes http://svn.apache.org/viewvc?view=revision&revision=1231878 Patches contributed by Ingo Schmidt native373: #i117733# no linux jre installation on 64 bit systems http://svn.apache.org/viewvc?view=revision&revision=1167536 native373: ##164464# improve debian support http://svn.apache.org/viewvc?view=revision&revision=1167537 Patch contribtued by Armin Le-Grand: Changed various aspects concerning usages of old vendor names http://svn.apache.org/viewvc?view=revision&revision=1293313 fix for neon webdav, remove coinmp bits, improve odk script, cleanup & remove OS/2 conditionals, system ucpp fixes, remove OS/2 conditionals, restore our license filenames.
2012-02-14Remove accidental commentThorsten Behrens
2012-02-13Integrate Josh Heidenreich's nice README parser as start page.Thorsten Behrens
From https://github.com/TheJosh/tdf-misc's scrape.php, ported the concept over to bash, to have it run with the doxygen generation.
2012-01-25Allow killing 'make docs' by Ctrl-c.Jan Holesovsky
2012-01-07Generate docs for basicAugust Sodora
2012-01-05Adapt doxygen gen script to changed Env file name.Thorsten Behrens
2011-10-15mkdocs: sort module listMiklos Vajna
2011-10-07Miklos wants writerfilter doxygen-ified, tooThorsten Behrens
2011-02-18Removed some commented code.Danny Roberts
2011-02-09Add basebmp to list of doxygen-processed modulesThorsten Behrens
2010-12-13Migrate id, tags, and docs make target over from build repoThorsten Behrens
* make id: create GNU idutils symbol lookup index * make tags: create ctags index file (c++, java, html) * make docs: create doxygen-style documentation below docs/
generated by cgit (git 2.34.1) at 2025-01-28 18:04:00 +0000