Cmake install and scripts #53

marvin2k · 2017-02-03T17:42:05Z

Thanks for this nice tool, worked better than I expected ;-) This PR might not be finished or polished, but might be helpful to others. It allows to

Install the data-folder, generator and indexer programs, as well as providing a new FindWoboq.cmake
Edited README for the linux installation procedure to do out-of-source builds. They are much inferior.
Disabled strict-aliasing, as gcc6 will emit many warnings due to type-pruning in llvm headers. Can't change these. Better safe than sorry.

If FindWoboq.cmake is findable in $CMAKE_MODULE_PATH, there is a new function CreateBrowsableDocumentation(TARGET $trgt). It will create targets like woboq-$trgt, woboq and woboq-serve. So adding the following to a CMakeLists:

# of course, provide the correct installation location
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "/opt/woboq.install/share/woboq/cmake")
find_package(Woboq REQUIRED)
CreateBrowsableDocumentation(TARGETS subtarget1 subtarget2 maintarget)

Then, after recreating the build-folder, start a python simple http server:

make -C build woboq-serve

And open the stuff in the browser:

xdg-open http://localhost:8000

Works for me ;-) The indexer seems a bit buggy or wrongly used be me -- css is broken in some locations?

Sidenote: Generated files located inside the build-folder (Qt...) are missing if the build folder is not inside the src-folder. See ProjectManager::projectForFile. This is inconvenient in a CI-environment for example.

who builds in-source anyways? Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

provides functions to add targets for scanning: add the following to a CMakeLists: set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "/opt/woboq.install/share/woboq/cmake") find_package(Woboq REQUIRED) CreateBrowsableDocumentation(TARGETS subtarget1 subtarget2 maintarget) then, after recreating the build-folder, call make like so: make -C build woboq-serve and open the stuff in the browser: xdg-open http://localhost:8000 Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

CLAassistant · 2017-02-03T17:43:06Z

All committers have signed the CLA.

- two separate projects, for source and file generated inside the build folder - fixed data-argument for indexgenerator to be "/data" Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

even better Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

ogoffart

Thanks for your contribution.
I haven't tought to use cmake this way.

Note that we don't support "incremental" change, so we should make sure the output directory is clean before running the generator.

Other than that i don't know cmake so much so it's hard to review all this code. It seems that it depends on python and on the simple http server, but that's not explicit.
Do the export-compile-command flag gets set on the project's root?

ogoffart · 2017-02-13T17:23:00Z

README.md

-cmake . -DLLVM_CONFIG_EXECUTABLE=/opt/llvm/bin/llvm-config -DCMAKE_BUILD_TYPE=Release
-make
+mkdir -p build && cd build
+cmake .. -DLLVM_CONFIG_EXECUTABLE=llvm-config-3.8 -DCMAKE_INSTALL_PREFIX=$HOME/woboq.install -DCMAKE_BUILD_TYPE=Release


But the README does not tell to create a build directory.

I personaly use shadow build., but i think in-source builod are simpler to explain. And anybody familiar with cmake knows how to make a shadow build.

sure it does, mkdir -p build && cd build? What is a shadow build?

ogoffart · 2017-02-13T17:33:50Z

FindWoboq.cmake.in

+    set(outdir ${WOBOQ_OUTDIR})
+
+    # this will (?) retrieve where the CMakeLists of this target is located. I
+    # think this is what the second part of the "-p" switch needs...


Yes, that's correct.

ogoffart · 2017-02-13T17:36:18Z

FindWoboq.cmake.in

+    # the global build directory. this will pout all generated file into a
+    # parallel page-tree in the served html.
+    get_property(blddir TARGET ${trgt} PROPERTY BINARY_DIR)
+    set(bldprjct ${trgt}/build:${blddir})


But i don't think "build" should be hard-coded here.

Note that because it is a sub directory, it will simply appear in a subdirectory of the project as normal .

What does make sense, instead of hardcoding? Maybe an additional function parameter with a default-argument? Rename to "generated" or "builddirectory"?

…to running hope this catches everything... Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

marvin2k · 2017-02-14T10:38:26Z

Uh, hadn't realized the incremental aspect. It seems to work, but removing cpp/hpp files might cause problems? Yeah, cleaning the ${srcprjct} and ${bldprojct} prior to running sounds like a good idea

otherwise all this will not work if "data" is somewhere completely else Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

guruz · 2017-08-10T10:02:44Z

FYI #58 was merged which partly overlaps here

marvin2k · 2017-08-10T12:57:59Z

ui. Gut zu wissen. Wir müssten mal rebasen ;-)

…

On 08/10/2017 12:02 PM, Markus Goetz wrote: FYI #58 <#58> was merged which partly overlaps here — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#53 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAN16kvHtwOlKI0c2H8MyHQ_WkY5rZsQks5sWtVFgaJpZM4L2mxl>.

-- M.Sc. Martin Zenzes Space Robotics Hauptgeschäftsstelle Standort Bremen: DFKI GmbH Robotics Innovation Center Robert-Hooke-Straße 5 28359 Bremen, Germany Phone: +49 (0) 421 178 45 - 6658 Fax: +49 (0) 421 178 45 - 4150 E-Mail: martin.zenzes@dfki.de Weitere Informationen: http://www.dfki.de/robotik ----------------------------------------------------------------------- Deutsches Forschungszentrum fuer Kuenstliche Intelligenz GmbH Firmensitz: Trippstadter Straße 122, D-67663 Kaiserslautern Geschaeftsfuehrung: Prof. Dr. Dr. h.c. mult. Wolfgang Wahlster (Vorsitzender) Dr. Walter Olthoff Vorsitzender des Aufsichtsrats: Prof. Dr. h.c. Hans A. Aukes Amtsgericht Kaiserslautern, HRB 2313 Sitz der Gesellschaft: Kaiserslautern (HRB 2313) USt-Id.Nr.: DE 148646973 Steuernummer: 19/673/0060/3 -----------------------------------------------------------------------

Waqar144 · 2022-11-07T11:54:51Z

too old

marvin2k added 5 commits February 3, 2017 11:16

gitignore: ignore build-directory

5745fda

who builds in-source anyways? Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

cmake: add install directives

a107404

Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

add "-fno-strict-aliasing" to silence complains from gcc

21678f2

Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

specify out-of-source build in README

bf2ad55

Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

marvin2k added 3 commits February 9, 2017 18:34

greatly improve cmake-module

10802ff

- two separate projects, for source and file generated inside the build folder - fixed data-argument for indexgenerator to be "/data" Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

place build-atrifacts into folder "build" _inside_ the actual project

f51d726

even better Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

cmake: add "install" for the generated documentation code

9597184

Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

ogoffart reviewed Feb 13, 2017

View reviewed changes

marvin2k added 2 commits February 14, 2017 11:36

woboq does not support incremental builds: clean output folder prior …

2d0802f

…to running hope this catches everything... Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

findcmake: massage comments

3ff9f54

Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

marvin2k force-pushed the cmake_install_and_scripts branch from f504a43 to 3ff9f54 Compare February 14, 2017 10:37

calling the "generator" also needs the "-d" switch

6bca07c

otherwise all this will not work if "data" is somewhere completely else Signed-off-by: Martin Zenzes <martin.zenzes@dfki.de>

ogoffart force-pushed the master branch 2 times, most recently from 1d86342 to 1ba848f Compare January 8, 2018 16:51

Waqar144 closed this Nov 7, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Cmake install and scripts #53

Cmake install and scripts #53

Uh oh!

marvin2k commented Feb 3, 2017 •

edited

Loading

Uh oh!

CLAassistant commented Feb 3, 2017 •

edited

Loading

Uh oh!

ogoffart left a comment

Uh oh!

ogoffart Feb 13, 2017

Uh oh!

marvin2k Feb 14, 2017

Uh oh!

ogoffart Feb 13, 2017

Uh oh!

ogoffart Feb 13, 2017

Uh oh!

marvin2k Feb 14, 2017

Uh oh!

marvin2k commented Feb 14, 2017

Uh oh!

guruz commented Aug 10, 2017

Uh oh!

marvin2k commented Aug 10, 2017 via email

Uh oh!

Waqar144 commented Nov 7, 2022

Uh oh!

Uh oh!

Cmake install and scripts #53

Cmake install and scripts #53

Uh oh!

Conversation

marvin2k commented Feb 3, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CLAassistant commented Feb 3, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ogoffart left a comment

Choose a reason for hiding this comment

Uh oh!

ogoffart Feb 13, 2017

Choose a reason for hiding this comment

Uh oh!

marvin2k Feb 14, 2017

Choose a reason for hiding this comment

Uh oh!

ogoffart Feb 13, 2017

Choose a reason for hiding this comment

Uh oh!

ogoffart Feb 13, 2017

Choose a reason for hiding this comment

Uh oh!

marvin2k Feb 14, 2017

Choose a reason for hiding this comment

Uh oh!

marvin2k commented Feb 14, 2017

Uh oh!

guruz commented Aug 10, 2017

Uh oh!

marvin2k commented Aug 10, 2017 via email

Uh oh!

Waqar144 commented Nov 7, 2022

Uh oh!

Uh oh!

marvin2k commented Feb 3, 2017 •

edited

Loading

CLAassistant commented Feb 3, 2017 •

edited

Loading