← Back to team overview

kicad-developers team mailing list archive

Re: 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 Sidebotham
<brian.sidebotham@xxxxxxxxx> wrote:
> 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
> <brian.sidebotham@xxxxxxxxx> 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
>> <brian.sidebotham@xxxxxxxxx> wrote:
>>> On 15 September 2015 at 15:03, Wayne Stambaugh <stambaughw@xxxxxxxxx> 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.


References