It seems the plugin documentation doesn't get generated as part of the nightly builds.
As there have been quite a few additions and changes lately, many pages are outdated or just missing
Plugin documentation not current in the nightly builds
⇒
Plugin documentation not available in the nightly builds
Seems the nightly builds still don't generate the plugin documentation, nit for Windows at least
GIT commit: c65f00f
I see this in CMakeLists.txt:
{syntaxhighlighter }
add_custom_command(OUTPUT ${PROJECT_BINARY_DIR}/plugins
COMMAND genManual ${PROJECT_SOURCE_DIR} ${PROJECT_BINARY_DIR}
DEPENDS genManual
)
In both the RELEASE and DEBUG builds, I see the following line in the compiling output between the "build" and "installation" phase...
---
[100%] Built target mscore
mingw32-make[3]: Entering directory `D:/MS_TRUNK/build.release'
mingw32-make[3]: Leaving directory `D:/MS_TRUNK/build.release'
[100%] Built target genManual
mingw32-make[2]: Leaving directory `D:/MS_TRUNK/build.release'
Install the project...
-- Install configuration: "RELEASE"
'make' is not recognized as an internal or external command,
operable program or batch file.
-- Installing: D:/MS_TRUNK/win32install/bin/mscore.exe
-- Up-to-date: D:/MS_TRUNK/win32install/bin/mingwm10.dll
---
That's what I thought as well. In the makefile.mingw it is listed as '$(MAKE)'. I tried "${MAKE}" (only in the DEBUG section) but it didn't work. I will replace them all and try again.
Replaced "make" with "mingw32-make" (both lines) and the plugin creator now has a help manual in the form of many HTML files. I assume this is what people were wanting? Can someone put in a pull request with this fix in it?
Both lines means exactly that, there's two lines with the "make" command in the section. Am I reading the directive logic incorrect? Does't the section below have two "make" commands, almost exactly the same, intended for the Windows platform?
if (MINGW)
install(CODE "execute_process(COMMAND cmd /c \"make install_plugins_manual\")")
else (MINGW)
install(CODE "execute_process(COMMAND make install_plugins_manual)")
endif (MINGW)
In my mind, only the first one will ever run as MINGW is true under Windows but figured both should be changed (or one removed). How else should I read the above? (I know C and understand C preprocessor directives but don't know makefile logic.)
If ever there is a time that David is not around to build and upload the nightlies to the MS site, I always build them at work during the week and upload to my own web space. It will be available tomorrow on http://ist.uwaterloo.ca/~schepers/musescore
[EDIT] I RDP'd to my machine and built the latest nightly. It's ready.
The manual is still not working in MuseScore, but I found out that the plugin documentation is generated when building MuseScore. On Linux Mint using Qt, we can find the last available properties and method in ~/MuseScore-build/share/manual/plugins
Comments
fixed in ad61857acf
not quite, now there is no manual at all, but should be fixed in 8d5a948
Still no manual at all in GIT commit: 024263f
Seems the nightly builds still don't generate the plugin documentation, nit for Windows at least
GIT commit: c65f00f
I see this in CMakeLists.txt:
{syntaxhighlighter }
add_custom_command(OUTPUT ${PROJECT_BINARY_DIR}/plugins
COMMAND genManual ${PROJECT_SOURCE_DIR} ${PROJECT_BINARY_DIR}
DEPENDS genManual
)
add_custom_target(install_plugins_manual
COMMAND ${PROJECT_BINARY_DIR}/manual/genManual ${PROJECT_SOURCE_DIR} /usr/local/${Mscore_SHARE_NAME}${Mscore_INSTALL_NAME}manual
)
install(CODE "execute_process(COMMAND make install_plugins_manual)")
{/syntaxhighlighter}
That '/usr/local' seem to indicate that if may only work for Linux?
Still an issue in b75d23e for Windows
Does it work for Mac?
Closed as a duplicate of #18122: make install_plugins_manual doesn't use CMAKE_INSTALL_PREFIX path, which seems to have spotted the root cause
reopening, as per lasconic the fix for #18122: make install_plugins_manual doesn't use CMAKE_INSTALL_PREFIX path may not fix this issue. Will check in the next nightly whether it did...
I didn't check the nightlies but in my own windows build, it does't work. I'm not sure why but the INSTALL(CODE line seems to be ignored.
I can confirm that for the nightly build. Pitty, back to the drawing board...
Next nightly 6bf8e61e03 on windows should be fixed. It still doesn't work on mac.
Would it be 'sh -c' on a Mac?
Still not working on the (Windows) nightly build e146aba
Still an issue in 792e398
In both the RELEASE and DEBUG builds, I see the following line in the compiling output between the "build" and "installation" phase...
---
[100%] Built target mscore
mingw32-make[3]: Entering directory `D:/MS_TRUNK/build.release'
mingw32-make[3]: Leaving directory `D:/MS_TRUNK/build.release'
[100%] Built target genManual
mingw32-make[2]: Leaving directory `D:/MS_TRUNK/build.release'
Install the project...
-- Install configuration: "RELEASE"
'make' is not recognized as an internal or external command,
operable program or batch file.
-- Installing: D:/MS_TRUNK/win32install/bin/mscore.exe
-- Up-to-date: D:/MS_TRUNK/win32install/bin/mingwm10.dll
---
Note the "'make' is not recognized..." line.
shouldn't that be cmake (on Windows)? or ${MAKE} (to make it generic)?
That's what I thought as well. In the makefile.mingw it is listed as '$(MAKE)'. I tried "${MAKE}" (only in the DEBUG section) but it didn't work. I will replace them all and try again.
Nope, didn't work. Where is '$(MAKE)' defined as I can't find it in either makefile.mingw or mingw32.mingw.cmake?
OK, I found the problem but don't know how to fix it. In the project root in cmakelists.txt is the follow code:
---
if (MINGW)
install(CODE "execute_process(COMMAND cmd /c \"make install_plugins_manual\")")
else (MINGW)
install(CODE "execute_process(COMMAND make install_plugins_manual)")
endif (MINGW)
---
There is no 'make' command anywhere.
and
if (MINGW)
install(CODE "execute_process(COMMAND cmd /c \"cmake install_plugins_manual\")")
else (MINGW)
install(CODE "execute_process(COMMAND make install_plugins_manual)")
endif (MINGW)
doesn't solve the problem?
No, I tried that too. Cmake complains that the "install_plugins_manual" directory doesn't exist (something like that).
The exact message is "CMake Error: The source directory "D:/MS_TRUNK/build.release/install_plugins_manual" does not exist."
OK good hunting.
Can you try to change
makebymingw32-makeReplaced "make" with "mingw32-make" (both lines) and the plugin creator now has a help manual in the form of many HTML files. I assume this is what people were wanting? Can someone put in a pull request with this fix in it?
I can, but not today. What do you mean by 'both lines'?
I pushed the proposed fix in cf850d8d48
Both lines means exactly that, there's two lines with the "make" command in the section. Am I reading the directive logic incorrect? Does't the section below have two "make" commands, almost exactly the same, intended for the Windows platform?
if (MINGW)
install(CODE "execute_process(COMMAND cmd /c \"make install_plugins_manual\")")
else (MINGW)
install(CODE "execute_process(COMMAND make install_plugins_manual)")
endif (MINGW)
In my mind, only the first one will ever run as MINGW is true under Windows but figured both should be changed (or one removed). How else should I read the above? (I know C and understand C preprocessor directives but don't know makefile logic.)
if minwg, else rest ot the world, here Mac and Linux. Only mingw needs that modification.
hmm, no new Windows nightly builds since a week?
If ever there is a time that David is not around to build and upload the nightlies to the MS site, I always build them at work during the week and upload to my own web space. It will be available tomorrow on http://ist.uwaterloo.ca/~schepers/musescore
[EDIT] I RDP'd to my machine and built the latest nightly. It's ready.
Thanks, guess we can mark this issue fixed then.
Still an issue for the Mac builds, see http://musescore.org/en/node/17294#comment-68649
I pushed a fix in 2d3b0b983d
It's working on my mac, let see if it works for next nightlies and doesn't break anything on other platforms.
The next Mac nightly is available already, •MuseScoreNightly-2012-11-13-1556-2d3b0b9.dmg
Mac is said to be working, Windows (still) works too, and Linux had been fixed quite a while ago and hopefully not been broken again
Automatically closed -- issue fixed for 2 weeks with no activity.
I reopen this bug, because on my Linux Mint 17 with latest MuseScore build (3d19d74) there is no manual in the plugin creator.
I think there should at least be an online version that we could access, otherwise there is no documentation for the new QML plugin system.
the nighly builds for Linux just don't containg this, just the MuseScore binary. Mac and Windows do have them though.
So for Linux nighlies this is sort of 'by design' unfortunatly. The 2.0 beta will have it.
Ok, then is there anywhere else I could get that documentation if I want to work on a plugin?
Does the attached help?
Great! That's a good start!
Do you know if we can access the measure number? I didn't see it in the documentation.
The manual is still not working in MuseScore, but I found out that the plugin documentation is generated when building MuseScore. On Linux Mint using Qt, we can find the last available properties and method in
~/MuseScore-build/share/manual/pluginsWhat isn't working? In Linux nightly build it won't work, as there it contains the executable only, but for Windows and Mac it does work.
Sorry, I should I specified "in Linux". But at least, when compiling from source, we can get the manual in the build folder.
Btw, is it planed to have the manual working in Linux one day?