Documentation creation: remove temporary files

[Hachmann]

Temporary files created during documentation creation should be removed after they are no longer needed, or they should be saved in a location meant for temporary files.

(.gitignore can then be adapted)

[Patrick Storz (ede123)]

Are we missing any temporary files at the current point?

Long term goal would obviously be to solve bug #1735308. Unfortunately it's a lot (unjustified amount?) of work which is why it will probably not happen in the foreseeable future...

[Hachmann (marenhachmann)]

For Inkscape, there's a /build directory, too ;-) But I guess we can live without one.

Is it intentional that for export-inkscape, there is a /man subdirectory, but tutorials are in the main directory, and there is no /tutorials directory?

I did a folder comparison on a directory where I ran make all, then make clean vs. one where I didn't.

Make clean seems to remove everything that doesn't belong (unless one cancels make while it's running, then - at least in earlier versions - the temporary files stay in. They also show up in git status, as far as I could see.).

Make clean still removes tutorials from export-website and export-inkscape dir.
In export-inkscape, there are inkscape.<lang>.pod files in both the main directory as well as in man left over after clean. Also, there is one pod file called inkscape..pod in /export-inkscape.

[Patrick Storz (ede123)]

> For Inkscape, there's a /build directory, too

That specifically is bug #1735308.

> unless one cancels make while it's running

Well, what do you expect... Killing make and blaming it for not cleaning up it's own mess is kinda weird ;-)

> Make clean still removes tutorials from
> export-website and export-inkscape dir.

Ah, shoot, I checked that before and thought it was fixed.
Turns out it was a typo that existed since Nicolas added these targets initially (basically duplicating the "clean" target - don't ask me why GNU make behavior is to silently ignore duplicate targets) and I overlooked it again last time... Fixed in

  https://gitlab.com/inkscape/inkscape-docs/documentation/commit/7031d647705c0d17520f1044611dd493f3e838f4

> In export-inkscape, there are inkscape.<lang>.pod files in both
> the main directory as well as in man left over after clean.

I thought this is how we wanted it to be (don't touch export-* on clean)or am I misunderstanding something?

> Also, there is one pod file called inkscape..pod in /export-inkscape.

Thanks for spotting! This was a copy/paste error in one of yesterdays commits. Fixed in

  https://gitlab.com/inkscape/inkscape-docs/documentation/commit/ffdb0cf41cd8e3d2000c3e5a13c10079abb72128

[Hachmann (marenhachmann)]

> Well, what do you expect...

I didn't know what to expect, but thought it worth mentioning.

> I thought this is how we wanted it to be

Not with the duplicates, I think (unless they serve some purpose?), that's what that was about.

Thanks!

[Patrick Storz (ede123)]

What duplicates are you referring to? Could it be you have leftover files from a previous execution?

inkscape.<lang>.pod and inkscape.<lang>.pod.in are the files Inkscape uses for creation of the manpages - they are output files!

[Hachmann (marenhachmann)]

> What duplicates are you referring to?

>> In export-inkscape, there are inkscape.<lang>.pod files in both
>> the main directory as well as in man left over after clean.

I thought the .pod files were only relevant for the man page, not for the tutorials, but there were files with the same names in both directories.

And no, it couldn't have been a leftover, I've made two git clones in /tmp for that test.

[Hachmann (marenhachmann)]

To be more clear:

there was /export-inkscape/inkscape.de.pod
and
/export-inkscape/man/inkscape.de.pod

[Patrick Storz (ede123)]

As long as the latter file was actually
  /export-inkscape/man/inkscape.de.pod.in
it's perfectly fine.

The *.pod.in files are consumed by CMake, the *.pod files are created for backwards compatibility with older Autotools build and won't be required for master anymore.

I don't see how tutorials have to do anything with this.

[Hachmann (marenhachmann)]

For me, those file names were identical yesterday. And the pod files lived in the place where tutorials were saved.

[Patrick Storz (ede123)]

Sounds very strange... If you're still able to reproduce this we can try to debug it further, otherwise I don't know how to help. CI seems fine, too, so I really don't know what happened.

[Hachmann (marenhachmann)]

Now with the most recent version, I've only got pod.in inside ./man - previously, there were both pod and pod.in files.

The remaining question is:

The pod.in files are in export-inkscape/man, and the .pod files are in export-inkscape, along with the tutorials.

Is it intended that the pod files for the man page are living outside the man page directory? And that they share that place with the tutorials? And that there is no directory for the tutorials?

[Patrick Storz (ede123)]

OK, great!

You're absolutely right about the tutorials. I moved them to a tutorials/ subdirectory now [1].

As for man in two folders: that's basically mirroring of the location those files should have in the inkscape source (so strictly speaking tutorials should even go into share/tutorials/), but I think updating the Inkscape repo is something to do manually anyway, so it's probably fine now.

For master the .pod files in the root will go away anyway, so we'll have all files nicely in subdirectories.

[1] https://gitlab.com/inkscape/inkscape-docs/documentation/commit/5c8486e9891cd17c93385cc62706aa4829c4f56a

[Hachmann (marenhachmann)]

Sounds good :) Thank you! (esp. for explanation)

[Hachmann (marenhachmann)]

Guess we can close this?

[Patrick Storz (ede123)]

As you're the reporter I guess so, too ;-)