firebird-docs

Re: [Firebird-docs] Comment out empty images dir in build.xml?

[Paul V. <pa...@vi...>]

Hi Tilo,

> [ about the empty folder src\docs\firebirddocs\images: ]

> Let's comment it out then, and uncomment it as soon as something is
> placed in that folder. And when it is no longer empty, it will also
> no longer be pruned by "update -P", so that part of the problem will
> solve itself.

Meanwhile I've thought of something that may be better:

- create a file Readme.txt in the images dir;
- change the lines in the *html targets in build.xml that now read:
    <fileset dir="${src.dir}/docs/firebirddocs/images"/>
  to:
    <fileset dir="${src.dir}/docs/firebirddocs/images"
                                          excludes="Readme.txt"/>

The first step will prevent the local dir to be deleted by update -P.
The second step will prevent Readme.txt to be copied to the dist tree.

The advantage is that we won't have to change build.xml back and
forth; this solution will work whether image is "empty" (but for
Readme.txt) or not.

Readme.txt must contain a few lines to explain why it is there and
why it shouldn't be deleted. I call it Readme.txt instead of e.g.
Dummy.txt because this makes it more likely that someone will read
the contents before he decides to delete it.

What do you think?


Greetings,
Paul Vinkenoog

Re: [Firebird-docs] Comment out empty images dir in build.xml?

[Tilo M. <tm...@al...>]

Hi Paul,

"Paul Vinkenoog" <pa...@vi...> schrieb im Newsbeitrag
news:Pin...@s4......
> Hi Tilo,
>
> > [ about the empty folder src\docs\firebirddocs\images: ]
>
> > Let's comment it out then, and uncomment it as soon as something is
> > placed in that folder. And when it is no longer empty, it will also
> > no longer be pruned by "update -P", so that part of the problem will
> > solve itself.
>
> Meanwhile I've thought of something that may be better:
>
> - create a file Readme.txt in the images dir;
> - change the lines in the *html targets in build.xml that now read:
>     <fileset dir="${src.dir}/docs/firebirddocs/images"/>
>   to:
>     <fileset dir="${src.dir}/docs/firebirddocs/images"
>                                           excludes="Readme.txt"/>
>
> The first step will prevent the local dir to be deleted by update -P.
> The second step will prevent Readme.txt to be copied to the dist tree.
>
> The advantage is that we won't have to change build.xml back and
> forth; this solution will work whether image is "empty" (but for
> Readme.txt) or not.
>
> Readme.txt must contain a few lines to explain why it is there and
> why it shouldn't be deleted. I call it Readme.txt instead of e.g.
> Dummy.txt because this makes it more likely that someone will read
> the contents before he decides to delete it.
>
> What do you think?

Go for that workaround, later when the first image is used in the docs we
can rollback that change.

> Greetings,
> Paul Vinkenoog

--
Regards,
Tilo Muetze
--
Marathon - The SQL Tool for Firebird & InterBase
http://gmarathon.sourceforge.net

Re: [Firebird-docs] Comment out empty images dir in build.xml?

[Paul V. <pa...@vi...>]

Hello Tilo,

>>>[ about the empty folder src\docs\firebirddocs\images: ]
>>>
>>> Let's comment it out then, and uncomment it as soon as something
>>> is placed in that folder. And when it is no longer empty, it will
>>> also no longer be pruned by "update -P", so that part of the
>>> problem will solve itself.

>> Meanwhile I've thought of something that may be better:
>>
>> - create a file Readme.txt in the images dir;
>> - change the lines in the *html targets in build.xml that now read:
>>     <fileset dir="${src.dir}/docs/firebirddocs/images"/>
>>   to:
>>     <fileset dir="${src.dir}/docs/firebirddocs/images"
>>                                           excludes="Readme.txt"/>
>> (...)
>> What do you think?

> Go for that workaround, later when the first image is used in the
> docs we can rollback that change.

Er... sorry if I sound stupid (I'm a bit sleepy), but which one do you
mean? The first one (commenting out, later uncomment) or the second
(Readme.txt and excludes)?

Greetings,
Paul

Re: [Firebird-docs] Comment out empty images dir in build.xml?

[Tilo M. <tm...@al...>]

Hi Paul,

"Paul Vinkenoog" <pa...@vi...> schrieb im Newsbeitrag
news:Pin...@so......
> > Go for that workaround, later when the first image is used in the
> > docs we can rollback that change.
>
> Er... sorry if I sound stupid (I'm a bit sleepy), but which one do you
> mean? The first one (commenting out, later uncomment) or the second
> (Readme.txt and excludes)?

Hm maybe I don't get it, but when we have images in that dir none of them is
needed?! Sorry for the confusion ;)

> Greetings,
> Paul

--
Regards,
Tilo Muetze
--
Marathon - The SQL Tool for Firebird & InterBase
http://gmarathon.sourceforge.net

Re: [Firebird-docs] Comment out empty images dir in build.xml?

[Paul V. <pa...@vi...>]

Hi Tilo,

>>> Go for that workaround, later when the first image is used in the
>>> docs we can rollback that change.

>> Er... sorry if I sound stupid (I'm a bit sleepy), but which one do
>> you mean? The first one (commenting out, later uncomment) or the
>> second (Readme.txt and excludes)?

> Hm maybe I don't get it, but when we have images in that dir none of
> them is needed?!

That's right, but the difference is that once we have images there:
1) the first workaround MUST be rolled back, or else the images don't
   get copied to dist, whereas
2) the second one CAN be rolled back, but it can also stay in place

> Sorry for the confusion ;)

Yeah, but now you've got me even more confused because I still don't
know which one you prefer :-)

Think I'll better go to bed... clearer head tomorrow.

Schlaf wohl, du Himmelsknabe du ;-)
Paul

Re: [Firebird-docs] Comment out empty images dir in build.xml?

[Tilo M. <tm...@al...>]

Hi Paul,

"Paul Vinkenoog" <pa...@vi...> schrieb im Newsbeitrag
news:Pin...@s4......
> That's right, but the difference is that once we have images there:
> 1) the first workaround MUST be rolled back, or else the images don't
>    get copied to dist, whereas
> 2) the second one CAN be rolled back, but it can also stay in place
>
> > Sorry for the confusion ;)
>
> Yeah, but now you've got me even more confused because I still don't
> know which one you prefer :-)


I meant to say, rollback 1) and 2) when images are used in the docs. Or in
other words: whatever method we use they are both workarounds until the
images are used, therefore they are no longer needed when the images are
used (Englische Sprache, schwere Sprache...).

> Think I'll better go to bed... clearer head tomorrow.
>
> Schlaf wohl, du Himmelsknabe du ;-)

Ich als süßes Kind schlief tatsächlich sehr wohl ;)

--
Regards,
Tilo Muetze
--
Marathon - The SQL Tool for Firebird & InterBase
http://gmarathon.sourceforge.net

Re: [Firebird-docs] Comment out empty images dir in build.xml?

[Paul V. <pa...@vi...>]

Hi Tilo,

>> That's right, but the difference is that once we have images there:
>> 1) the first workaround MUST be rolled back, or else the images
>>    don't get copied to dist, whereas
>> 2) the second one CAN be rolled back, but it can also stay in place

> I meant to say, rollback 1) and 2) when images are used in the
> docs. Or in other words: whatever method we use they are both
> workarounds until the images are used, therefore they are no longer
> needed when the images are used

OK, I went for #1 (temp. comment out lines in build.xml). It's less
"clever" but also simpler, and easier to make undone when the time
comes.

> (Englische Sprache, schwere Sprache...).

It still feels weird talking to you in English.

>> Schlaf wohl, du Himmelsknabe du ;-)
> Ich als s=FC=DFes Kind schlief tats=E4chlich sehr wohl ;)

;-)

Greetings,
Paul Vinkenoog