Re: [Kicad-developers] Problem of kicad-source and kicad-doc Packaging Help Documents
Actually the help documentation is broken on Windows too in the RC. The help is at C:\Program Files\KiCad\share\doc\kicad\help\en\kicad.pdf The searched paths are like this: Path C:\msys64\mingw64 C:\Program Files\KiCad\share\kicad\template\doc\help\en_GB C:\Program Files\KiCad\kicad.html C:\Program Files\KiCad C:\Program Files\KiCad\kicad.html C:\Program Files\KiCad C:\Program Files\KiCad\share\kicad\template\doc\help\en_GB C:\Program Files\KiCad\kicad.pdf C:\Program Files\KiCad C:\Program Files\KiCad\kicad.pdf C:\Program Files\KiCad C:\Program Files\KiCad\share\kicad\template\share\doc\kicad\help\en_GB C:\Program Files\KiCad\kicad.html C:\Program Files\KiCad C:\Program Files\KiCad\kicad.html C:\Program Files\KiCad C:\Program Files\KiCad\share\kicad\template\share\doc\kicad\help\en_GB C:\Program Files\KiCad\kicad.pdf C:\Program Files\KiCad C:\Program Files\KiCad\kicad.pdf C:\Program Files\KiCad C:\Program Files\KiCad\share\kicad\template\doc\help\en C:\Program Files\KiCad\kicad.html C:\Program Files\KiCad C:\Program Files\KiCad\kicad.html C:\Program Files\KiCad C:\Program Files\KiCad\share\kicad\template\doc\help\en C:\Program Files\KiCad\kicad.pdf C:\Program Files\KiCad C:\Program Files\KiCad\kicad.pdf C:\Program Files\KiCad C:\Program Files\KiCad\share\kicad\template\share\doc\kicad\help\en C:\Program Files\KiCad\kicad.html C:\Program Files\KiCad C:\Program Files\KiCad\kicad.html C:\Program Files\KiCad C:\Program Files\KiCad\share\kicad\template\share\doc\kicad\help\en C:\Program Files\KiCad\kicad.pdf C:\Program Files\KiCad C:\Program Files\KiCad\kicad.pdf C:\Program Files\KiCad C:\Program Files\KiCad\share\kicad\template\doc\help\en C:\Program Files\KiCad\kicad.html C:\Program Files\KiCad C:\Program Files\KiCad\kicad.html C:\Program Files\KiCad C:\Program Files\KiCad\share\kicad\template\doc\help\en C:\Program Files\KiCad\kicad.pdf C:\Program Files\KiCad C:\Program Files\KiCad\kicad.pdf C:\Program Files\KiCad C:\Program Files\KiCad\share\kicad\template\share\doc\kicad\help\en C:\Program Files\KiCad\kicad.html C:\Program Files\KiCad C:\Program Files\KiCad\kicad.html C:\Program Files\KiCad C:\Program Files\KiCad\share\kicad\template\share\doc\kicad\help\en C:\Program Files\KiCad\kicad.pdf C:\Program Files\KiCad C:\Program Files\KiCad\kicad.pdf C:\Program Files\KiCad It looks like a two-fold problem. The packaging is putting the docs under share\doc... where I guess it should be share\kicad\doc along with everything else shared for KiCad. Secondly the paths being search by the program include share\kicad\template... which appears wrong. I'd expect it to be \share\kicad\doc... Are these assumptions correct? If so, I can file a bug to be fixed. Best Regards, Brian. On 15 September 2015 at 15:37, Brian Sidebothamwrote: > On 15 September 2015 at 15:03, Wayne Stambaugh wrote: >> >> >> On 9/14/2015 1:08 AM, Joseph Chen wrote: >>> On 09/13/2015 01:36 PM, Wayne Stambaugh wrote: >>> The failure above is inevitable, because the running pcbnew is looking >>> for file name "pcbnew.pdf", while the actual doc file name installed as >>> "Pcbnew.pdf", noticing the mixed-case capital P in the actual file name. >> >> Good catch. The new documentation pdf generation code must have >> inadvertently used Pcbnew.pdf instead of pcbnew.pdf. I just looked at >> this in the github kicad-doc repo and this also seems to be the case for >> the other pdf files as well. Would one of our doc devs please fix this >> before the stable release? Thanks. > > I've created the issue: https://github.com/KiCad/kicad-doc/issues/156 > > I'll sort this out so it at least the documentation build produces the > correctly named files. > > Best Regards, > > Brian. ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Problem of kicad-source and kicad-doc Packaging Help Documents
I filed a bug report for the Windows version so people using RC1 may trip over the bug report. https://bugs.launchpad.net/kicad/+bug/1496049 Best Regards, Brian. On 15 September 2015 at 17:04, Brian Sidebothamwrote: > As a PS - I think RC2 looks like it's just round the corner because > not being able to look the help documents is pretty poor. > > There's no links to the documentation in the start menu either so we'd > have to point people to the install directory\share\doc\kicad... etc. > > Best Regards, > > Brian. > > On 15 September 2015 at 17:01, Brian Sidebotham > wrote: >> Actually the help documentation is broken on Windows too in the RC. >> >> The help is at C:\Program Files\KiCad\share\doc\kicad\help\en\kicad.pdf >> >> The searched paths are like this: >> >> Path >> C:\msys64\mingw64 >> C:\Program Files\KiCad\share\kicad\template\doc\help\en_GB >> C:\Program Files\KiCad\kicad.html >> C:\Program Files\KiCad >> C:\Program Files\KiCad\kicad.html >> C:\Program Files\KiCad >> C:\Program Files\KiCad\share\kicad\template\doc\help\en_GB >> C:\Program Files\KiCad\kicad.pdf >> C:\Program Files\KiCad >> C:\Program Files\KiCad\kicad.pdf >> C:\Program Files\KiCad >> C:\Program Files\KiCad\share\kicad\template\share\doc\kicad\help\en_GB >> C:\Program Files\KiCad\kicad.html >> C:\Program Files\KiCad >> C:\Program Files\KiCad\kicad.html >> C:\Program Files\KiCad >> C:\Program Files\KiCad\share\kicad\template\share\doc\kicad\help\en_GB >> C:\Program Files\KiCad\kicad.pdf >> C:\Program Files\KiCad >> C:\Program Files\KiCad\kicad.pdf >> C:\Program Files\KiCad >> C:\Program Files\KiCad\share\kicad\template\doc\help\en >> C:\Program Files\KiCad\kicad.html >> C:\Program Files\KiCad >> C:\Program Files\KiCad\kicad.html >> C:\Program Files\KiCad >> C:\Program Files\KiCad\share\kicad\template\doc\help\en >> C:\Program Files\KiCad\kicad.pdf >> C:\Program Files\KiCad >> C:\Program Files\KiCad\kicad.pdf >> C:\Program Files\KiCad >> C:\Program Files\KiCad\share\kicad\template\share\doc\kicad\help\en >> C:\Program Files\KiCad\kicad.html >> C:\Program Files\KiCad >> C:\Program Files\KiCad\kicad.html >> C:\Program Files\KiCad >> C:\Program Files\KiCad\share\kicad\template\share\doc\kicad\help\en >> C:\Program Files\KiCad\kicad.pdf >> C:\Program Files\KiCad >> C:\Program Files\KiCad\kicad.pdf >> C:\Program Files\KiCad >> C:\Program Files\KiCad\share\kicad\template\doc\help\en >> C:\Program Files\KiCad\kicad.html >> C:\Program Files\KiCad >> C:\Program Files\KiCad\kicad.html >> C:\Program Files\KiCad >> C:\Program Files\KiCad\share\kicad\template\doc\help\en >> C:\Program Files\KiCad\kicad.pdf >> C:\Program Files\KiCad >> C:\Program Files\KiCad\kicad.pdf >> C:\Program Files\KiCad >> C:\Program Files\KiCad\share\kicad\template\share\doc\kicad\help\en >> C:\Program Files\KiCad\kicad.html >> C:\Program Files\KiCad >> C:\Program Files\KiCad\kicad.html >> C:\Program Files\KiCad >> C:\Program Files\KiCad\share\kicad\template\share\doc\kicad\help\en >> C:\Program Files\KiCad\kicad.pdf >> C:\Program Files\KiCad >> C:\Program Files\KiCad\kicad.pdf >> C:\Program Files\KiCad >> >> It looks like a two-fold problem. The packaging is putting the docs >> under share\doc... where I guess it should be share\kicad\doc along >> with everything else shared for KiCad. >> >> Secondly the paths being search by the program include >> share\kicad\template... which appears wrong. I'd expect it to be >> \share\kicad\doc... >> >> Are these assumptions correct? If so, I can file a bug to be fixed. >> >> Best Regards, >> >> Brian. >> >> On 15 September 2015 at 15:37, Brian Sidebotham >> wrote: >>> On 15 September 2015 at 15:03, Wayne Stambaugh wrote: On 9/14/2015 1:08 AM, Joseph Chen wrote: > On 09/13/2015 01:36 PM, Wayne Stambaugh wrote: > The failure above is inevitable, because the running pcbnew is looking > for file name "pcbnew.pdf", while the actual doc file name installed as > "Pcbnew.pdf", noticing the mixed-case capital P in the actual file name. Good catch. The new documentation pdf generation code must have inadvertently used Pcbnew.pdf instead of pcbnew.pdf. I just looked at this in the github kicad-doc repo and this also seems to be the case for the other pdf files as well. Would one of our doc devs please fix this before the stable release? Thanks. >>> >>> I've created the issue: https://github.com/KiCad/kicad-doc/issues/156 >>> >>> I'll sort this out so it at least the documentation build produces the >>> correctly named files. >>> >>> Best Regards, >>> >>> Brian. ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Problem of kicad-source and kicad-doc Packaging Help Documents
As a PS - I think RC2 looks like it's just round the corner because not being able to look the help documents is pretty poor. There's no links to the documentation in the start menu either so we'd have to point people to the install directory\share\doc\kicad... etc. Best Regards, Brian. On 15 September 2015 at 17:01, Brian Sidebothamwrote: > Actually the help documentation is broken on Windows too in the RC. > > The help is at C:\Program Files\KiCad\share\doc\kicad\help\en\kicad.pdf > > The searched paths are like this: > > Path > C:\msys64\mingw64 > C:\Program Files\KiCad\share\kicad\template\doc\help\en_GB > C:\Program Files\KiCad\kicad.html > C:\Program Files\KiCad > C:\Program Files\KiCad\kicad.html > C:\Program Files\KiCad > C:\Program Files\KiCad\share\kicad\template\doc\help\en_GB > C:\Program Files\KiCad\kicad.pdf > C:\Program Files\KiCad > C:\Program Files\KiCad\kicad.pdf > C:\Program Files\KiCad > C:\Program Files\KiCad\share\kicad\template\share\doc\kicad\help\en_GB > C:\Program Files\KiCad\kicad.html > C:\Program Files\KiCad > C:\Program Files\KiCad\kicad.html > C:\Program Files\KiCad > C:\Program Files\KiCad\share\kicad\template\share\doc\kicad\help\en_GB > C:\Program Files\KiCad\kicad.pdf > C:\Program Files\KiCad > C:\Program Files\KiCad\kicad.pdf > C:\Program Files\KiCad > C:\Program Files\KiCad\share\kicad\template\doc\help\en > C:\Program Files\KiCad\kicad.html > C:\Program Files\KiCad > C:\Program Files\KiCad\kicad.html > C:\Program Files\KiCad > C:\Program Files\KiCad\share\kicad\template\doc\help\en > C:\Program Files\KiCad\kicad.pdf > C:\Program Files\KiCad > C:\Program Files\KiCad\kicad.pdf > C:\Program Files\KiCad > C:\Program Files\KiCad\share\kicad\template\share\doc\kicad\help\en > C:\Program Files\KiCad\kicad.html > C:\Program Files\KiCad > C:\Program Files\KiCad\kicad.html > C:\Program Files\KiCad > C:\Program Files\KiCad\share\kicad\template\share\doc\kicad\help\en > C:\Program Files\KiCad\kicad.pdf > C:\Program Files\KiCad > C:\Program Files\KiCad\kicad.pdf > C:\Program Files\KiCad > C:\Program Files\KiCad\share\kicad\template\doc\help\en > C:\Program Files\KiCad\kicad.html > C:\Program Files\KiCad > C:\Program Files\KiCad\kicad.html > C:\Program Files\KiCad > C:\Program Files\KiCad\share\kicad\template\doc\help\en > C:\Program Files\KiCad\kicad.pdf > C:\Program Files\KiCad > C:\Program Files\KiCad\kicad.pdf > C:\Program Files\KiCad > C:\Program Files\KiCad\share\kicad\template\share\doc\kicad\help\en > C:\Program Files\KiCad\kicad.html > C:\Program Files\KiCad > C:\Program Files\KiCad\kicad.html > C:\Program Files\KiCad > C:\Program Files\KiCad\share\kicad\template\share\doc\kicad\help\en > C:\Program Files\KiCad\kicad.pdf > C:\Program Files\KiCad > C:\Program Files\KiCad\kicad.pdf > C:\Program Files\KiCad > > It looks like a two-fold problem. The packaging is putting the docs > under share\doc... where I guess it should be share\kicad\doc along > with everything else shared for KiCad. > > Secondly the paths being search by the program include > share\kicad\template... which appears wrong. I'd expect it to be > \share\kicad\doc... > > Are these assumptions correct? If so, I can file a bug to be fixed. > > Best Regards, > > Brian. > > On 15 September 2015 at 15:37, Brian Sidebotham > wrote: >> On 15 September 2015 at 15:03, Wayne Stambaugh wrote: >>> >>> >>> On 9/14/2015 1:08 AM, Joseph Chen wrote: On 09/13/2015 01:36 PM, Wayne Stambaugh wrote: The failure above is inevitable, because the running pcbnew is looking for file name "pcbnew.pdf", while the actual doc file name installed as "Pcbnew.pdf", noticing the mixed-case capital P in the actual file name. >>> >>> Good catch. The new documentation pdf generation code must have >>> inadvertently used Pcbnew.pdf instead of pcbnew.pdf. I just looked at >>> this in the github kicad-doc repo and this also seems to be the case for >>> the other pdf files as well. Would one of our doc devs please fix this >>> before the stable release? Thanks. >> >> I've created the issue: https://github.com/KiCad/kicad-doc/issues/156 >> >> I'll sort this out so it at least the documentation build produces the >> correctly named files. >> >> Best Regards, >> >> Brian. ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Problem of kicad-source and kicad-doc Packaging Help Documents
On 9/14/2015 1:08 AM, Joseph Chen wrote: > On 09/13/2015 01:36 PM, Wayne Stambaugh wrote: >> The docs in lp:~kicad-developers/kicad/doc are obsolete. The latest >> docs are on github and are rebuilt whenever changes are made to the git >> repo and should be downloaded from there. >> >> It looks like your original problem is that you either did not configure >> CMake properly and/or didn't run sudo make install. You cannot install >> the docs in /usr on linux without root privileges. >> > > I've been cloning all the sources from the github, as shown here: > > |git clone https://github.com/KiCad/kicad-source-mirror.git git clone > https://github.com/KiCad/kicad-library.git git clone > https://github.com/KiCad/kicad-doc.git| > > Are they the correct ways to get the latest sources? Did I miss anything? These are correct. > > I also properly used "sudo" when required, so that should not be a factor. > > With these sources compiled and installed together, Pcbnew fails when I > click "Help -> Contents", with an error pop-up window saying "Help file > 'pcbnew' could not be found". > > The failure above is inevitable, because the running pcbnew is looking > for file name "pcbnew.pdf", while the actual doc file name installed as > "Pcbnew.pdf", noticing the mixed-case capital P in the actual file name. Good catch. The new documentation pdf generation code must have inadvertently used Pcbnew.pdf instead of pcbnew.pdf. I just looked at this in the github kicad-doc repo and this also seems to be the case for the other pdf files as well. Would one of our doc devs please fix this before the stable release? Thanks. > > One way to find out what the actual file name kicad is trying to open, > you can use Linux command "strace -o /tmp/kicad.out kicad", and then try > click "Help -> Contents". And then inspect the file "/tmp/kicad.out" > for any "*.pdf" file name. And this is how I found the mixed-case file > name. > > So my debugging shows that the root cause is the mis-matched directory > names and mixed-case file names, unless I got the source in a wrong way. > > --JC > > ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Problem of kicad-source and kicad-doc Packaging Help Documents
On 15 September 2015 at 15:03, Wayne Stambaughwrote: > > > On 9/14/2015 1:08 AM, Joseph Chen wrote: >> On 09/13/2015 01:36 PM, Wayne Stambaugh wrote: >> The failure above is inevitable, because the running pcbnew is looking >> for file name "pcbnew.pdf", while the actual doc file name installed as >> "Pcbnew.pdf", noticing the mixed-case capital P in the actual file name. > > Good catch. The new documentation pdf generation code must have > inadvertently used Pcbnew.pdf instead of pcbnew.pdf. I just looked at > this in the github kicad-doc repo and this also seems to be the case for > the other pdf files as well. Would one of our doc devs please fix this > before the stable release? Thanks. I've created the issue: https://github.com/KiCad/kicad-doc/issues/156 I'll sort this out so it at least the documentation build produces the correctly named files. Best Regards, Brian. ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Problem of kicad-source and kicad-doc Packaging Help Documents
The docs in lp:~kicad-developers/kicad/doc are obsolete. The latest docs are on github and are rebuilt whenever changes are made to the git repo and should be downloaded from there. It looks like your original problem is that you either did not configure CMake properly and/or didn't run sudo make install. You cannot install the docs in /usr on linux without root privileges. On 9/13/2015 12:01 AM, Joseph Chen wrote: > Is this a known issue or just me? > > With running KiCAD on my linux, I have long noticed that the "help > documents" are not accessible by the running "KiCAD". I recently found > a work-around to make them work for me. The work-around is to create > some symbolic links as shown here (if your email reader cannot display > the long lines, look at the attached the text file that contains these > links): > > ./usr/local/share/doc/kicad/help/en/pcbnew.pdf -> > /home/jchen/kicad-local-installed/usr/local/share/doc/kicad/help/en/Pcbnew/pdf/Pcbnew.pdf > > ./usr/local/share/doc/kicad/help/en/cvpcb.pdf -> > /home/jchen/kicad-local-installed/usr/local/share/doc/kicad/help/en/CvPcb/pdf/CvPcb.pdf > > ./usr/local/share/doc/kicad/help/en/eeschema.pdf -> > /home/jchen/kicad-local-installed/usr/local/share/doc/kicad/help/en/Eeschema/pdf/Eeschema.pdf > > ./usr/local/share/doc/kicad/help/en/gerbview.pdf -> > /home/jchen/kicad-local-installed/usr/local/share/doc/kicad/help/en/GerbView/pdf/GerbView.pdf > > ./usr/local/share/doc/kicad/help/en/Getting_Started_in_KiCad.pdf -> > /home/jchen/kicad-local-installed/usr/local/share/doc/kicad/help/en/Getting_Started_in_KiCad/pdf/Getting_Started_in_KiCad.pdf > > ./usr/local/share/doc/kicad/help/en/kicad.pdf -> > /home/jchen/kicad-local-installed/usr/local/share/doc/kicad/help/en/KiCad/pdf/KiCad.pdf > > > As you can see from the lines, the symbolic links circumvent the root > causes of the problem. The root causes seem to be resulted in with > mis-assumptions between the codes of "kicad-source" and "kicad-doc". > Here is the list of some mis-assumptions: > > 1. The "kicad-doc" assumes that the installation destination directory is > ${CMAKE_INSTALL_PREFIX}/en/ > > while "kicad-source" code assumes that the documents installed by > "kicad-doc" is located in > ${CMAKE_INSTALL_PREFIX}/share/doc/kicad/help/en/ > > 2. The "kicad-doc" assumes extra directory layers like "/pdf", "/html", > ect., while "kicad-source" does not. > > 3. The "kicad-doc" uses mixed letter cases for file names, while > "kicad-source" uses mostly lower cases. While this mixed-case file > names may not be a problem for Windows OS, it is definitely a real > problem for Linux, and for OS-X of users who installed OS-X with > case-sensitive file-system, myself included. > > I don't have a good idea how to fix these, but hope someones there from > the two camps of "kicad-source" and "kicad-doc" have better ideas. > Thus I won't need my work-around anymore. > > --Joe > > > ___ > Mailing list: https://launchpad.net/~kicad-developers > Post to : kicad-developers@lists.launchpad.net > Unsubscribe : https://launchpad.net/~kicad-developers > More help : https://help.launchpad.net/ListHelp > ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
Re: [Kicad-developers] Problem of kicad-source and kicad-doc Packaging Help Documents
On 09/13/2015 01:36 PM, Wayne Stambaugh wrote: The docs in lp:~kicad-developers/kicad/doc are obsolete. The latest docs are on github and are rebuilt whenever changes are made to the git repo and should be downloaded from there. It looks like your original problem is that you either did not configure CMake properly and/or didn't run sudo make install. You cannot install the docs in /usr on linux without root privileges. I've been cloning all the sources from the github, as shown here: |git clone https://github.com/KiCad/kicad-source-mirror.git git clone https://github.com/KiCad/kicad-library.git git clone https://github.com/KiCad/kicad-doc.git| Are they the correct ways to get the latest sources? Did I miss anything? I also properly used "sudo" when required, so that should not be a factor. With these sources compiled and installed together, Pcbnew fails when I click "Help -> Contents", with an error pop-up window saying "Help file 'pcbnew' could not be found". The failure above is inevitable, because the running pcbnew is looking for file name "pcbnew.pdf", while the actual doc file name installed as "Pcbnew.pdf", noticing the mixed-case capital P in the actual file name. One way to find out what the actual file name kicad is trying to open, you can use Linux command "strace -o /tmp/kicad.out kicad", and then try click "Help -> Contents". And then inspect the file "/tmp/kicad.out" for any "*.pdf" file name. And this is how I found the mixed-case file name. So my debugging shows that the root cause is the mis-matched directory names and mixed-case file names, unless I got the source in a wrong way. --JC ___ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp