View Issue Details

IDProjectCategoryView StatusLast Update
0002546Spring engineGeneralpublic2013-02-19 16:47
Reporterabma Assigned Toabma  
PrioritynormalSeverityminorReproducibilityalways
Status resolvedResolutionfixed 
Summary0002546: cmake aborts when no pandoc is installed
DescriptionCMake Error at doc/CMakeLists.txt:126 (Message):
  user-docs generation (html/text) is not possible (disable with
  USERDOCS_HTML=FALSE); missing utility: pandoc or markdown

as this is optional, it should only print a warning
TagsNo tags attached.
Checked infolog.txt for Errors

Activities

hoijui

2011-07-15 17:26

reporter   ~0007041

USERDOCS_HTML is default TRUE on windows/mingw only.
i made it so, to increase the possibility for windows builds featuring the HTML versions of the userdocs, as windows users would usually not know how to open a file like "LICENSE" (no extension).
As mingwlibs comes with pandoc, this message/error is only seen if you build with MinGW on linux, you do not have pandoc or markdown installed, and you did not manually set USERDOCS_HTML=FALSE.
reconfiguring with "cmake -DUSERDOCS_HTML=FALSE" should not be a problem if you are otherwise able to compile spring on linux with MinGW.

So it is still optional, but there is a stronger incentive to build HTML docs for windows builds.

abma

2011-07-25 00:22

administrator   ~0007067

Last edited: 2011-07-25 02:09

because of this
http://springrts.com/phpbb/viewtopic.php?f=12&p=495859 ,this is on win32. even when cross-compiling i wouldn't force users to install pandoc or markdown.


i think it would better to create html, only when pandoc is installed. you can still print a big fat warning...

why to force users do create html-docs? html-docs are only required on the buildbot, and i think we don't miss the warning message, that there are no html-docs created... :)

hoijui

2011-07-26 18:28

reporter   ~0007079

i falsely though that mingwlibs already contains pandoc.
but i now added it, so this error will never show up for builds under windows.

it should abort, because others may build spring themselfs to bundle an installer or something, and we want to ensure HTML docs on any wide spread spring builds.

if you are building with mingw under linux, do not have markdown or pandoc installed, and you are too lazy to set -DUSERDOCS_HTML=FALSE (this is suggested in the error message) then well...
you would not have gotten this far in the first place.

abma

2011-07-26 18:59

administrator   ~0007080

hmm, if they make an installer theirself, they only have to grab
http://springrts.com/dl/buildbot/default/master/spring_testing_minimal-portable.7z


there is no requirement to compile it for repacking, this will only cause trouble...

hoijui

2011-07-26 21:10

reporter   ~0007083

give a use-case where it would cause trouble please.

abma

2011-07-27 00:42

administrator   ~0007089

Last edited: 2011-07-27 00:45

recompile for repacking can cause many problems:

-sync-errors
-damaged/broken/invalid/missing/additional files
-...

this is why i created the minimal-portable, this allows repacking without recompile...

while compiling, now it shouldn't make big problems, as pandoc is in mingwlibs. i would like html files as optional files... if pandoc isn't avaiable, just give a warning message.

abma

2013-02-19 16:47

administrator   ~0009851

fixed some time ago...

Issue History

Date Modified Username Field Change
2011-07-10 03:06 abma New Issue
2011-07-10 03:06 abma Graphics Card => unknown
2011-07-15 17:26 hoijui Note Added: 0007041
2011-07-25 00:22 abma Note Added: 0007067
2011-07-25 00:26 abma Note Edited: 0007067
2011-07-25 02:09 abma Note Edited: 0007067
2011-07-26 18:28 hoijui Note Added: 0007079
2011-07-26 18:59 abma Note Added: 0007080
2011-07-26 21:10 hoijui Note Added: 0007083
2011-07-27 00:42 abma Note Added: 0007089
2011-07-27 00:45 abma Note Edited: 0007089
2013-02-19 16:47 abma Note Added: 0009851
2013-02-19 16:47 abma Status new => resolved
2013-02-19 16:47 abma Resolution open => fixed
2013-02-19 16:47 abma Assigned To => abma