Created attachment 1033 [details]
a documentation merge patch for en_GB locale

tde-i18n-en_GB/docs/tdebase/khelpcenter/
    faq
    glossary
    quickstart
    userguide
    visualdict
contains the same documentation as 
tde-i18n-en_GB/docs/tdebase/
    faq
    glossary
    quickstart
    userguide
    visualdict

the version in tde-i18n-en_GB/docs/tdebase/ is newer but the correct location for those files is in the khelpcenter directory. So those files were just moved to subdirectory. Also missing files in the newer version wasn't deleted.

The file date stamps won't help because we have been routinely updating files. Any single patch updates the file date stamp in the sources.

The parent module directory is the baseline for deciding where the duplication occurs. For the help books listed, all are from tdebase. Therefore tdebase serves as the baseline.

The tde-i18n/tde-i18n-en_GB/docs/tdebase directory should be compared to tdebase/doc. They look similar.

Comparing the contents of tdebase/doc/khelpcenter and tde-i18n/tde-i18n-en_GB/docs/tdebase/khelpcenter shows the following extra directories in tde-i18n/tde-i18n-en_GB/docs/tdebase/khelpcenter:

faq
glossary
quickstart
userguide
visualdict

Those five directories are duplicates of the parent directory tde-i18n/tde-i18n-en_GB/docs/tdebase, which is the correct location for those files.

Using kompare to visually compare the contents of the docbook files between tde-i18n/tde-i18n-en_GB/docs/tdebase/khelpcenter/faq and tde-i18n/tde-i18n-en_GB/docs/tdebase/faq indicates the files in tde-i18n/tde-i18n-en_GB/docs/tdebase/faq are more current. So again the five directories in tde-i18n/tde-i18n-en_GB/docs/tdebase/khelpcenter seem to be the duplicates.

Seems then the solution is to delete the duplicates in tde-i18n/tde-i18n-en_GB/docs/tdebase/khelpcenter. Likewise for the other locales.

Deleting those duplicate directories removes "cruft" from the sources but does not address the problem that all of those files have not been reviewed by a translator. All of those docbook files have been updated in the English version in tdebase, which is the baseline for all translated version.

Does this make sense?

(In reply to comment #2)
> The file date stamps won't help because we have been routinely updating files.
> Any single patch updates the file date stamp in the sources.
> 
> The parent module directory is the baseline for deciding where the duplication
> occurs. For the help books listed, all are from tdebase. Therefore tdebase
> serves as the baseline.
> 
> The tde-i18n/tde-i18n-en_GB/docs/tdebase directory should be compared to
> tdebase/doc. They look similar.
> 
> Comparing the contents of tdebase/doc/khelpcenter and
> tde-i18n/tde-i18n-en_GB/docs/tdebase/khelpcenter shows the following extra
> directories in tde-i18n/tde-i18n-en_GB/docs/tdebase/khelpcenter:
> 
> faq
> glossary
> quickstart
> userguide
> visualdict
> 
> Those five directories are duplicates of the parent directory
> tde-i18n/tde-i18n-en_GB/docs/tdebase, which is the correct location for those
> files.
> 
> Using kompare to visually compare the contents of the docbook files between
> tde-i18n/tde-i18n-en_GB/docs/tdebase/khelpcenter/faq and
> tde-i18n/tde-i18n-en_GB/docs/tdebase/faq indicates the files in
> tde-i18n/tde-i18n-en_GB/docs/tdebase/faq are more current. So again the five
> directories in tde-i18n/tde-i18n-en_GB/docs/tdebase/khelpcenter seem to be the
> duplicates.
> 
> Seems then the solution is to delete the duplicates in
> tde-i18n/tde-i18n-en_GB/docs/tdebase/khelpcenter. Likewise for the other
> locales.
> 
> Deleting those duplicate directories removes "cruft" from the sources but does
> not address the problem that all of those files have not been reviewed by a
> translator. All of those docbook files have been updated in the English version
> in tdebase, which is the baseline for all translated version.
> 
> Does this make sense?

Yes.

I've decided to move all to khelpcenter/ because files are installed to ${HTML_INSTALL_DIR}/en/khelpcenter/ subdirs. So it may be make some sense to move them to khelpcenter/ in tdebase as well. Also it will involve similar changes in other translations. But it's not a first-priority task, for now it's ok to merge all this to doc/tdebase/.

Also those merges should be produced carefully: some files are missing in newer version but present in old one(or may be they was just founded to be obsolete). Anyway IMO they should be moved to new directories and installed as well, otherwise it could break existing documentation.

Darrell, can you handle it yourself because it's quite easy to do but patches for such changes are large and creepy. So it would be easier for person with commit access.

I'm assigning this report to me.

My apologies for forgetting about this report. :-(

The parent tdebase/doc/khelpcenter directory has only files and no subdirectories. All of the tde-i18n khelpcenter directories should be the same.

I looked again at the entire tde-i18n module. The following locale submodules need to have subdirectories deleted OR moved from the respective khelpcenter:

* en_GB
* fr
* hu
* it
* ja
* pt
* sk
* sl
* tr

The trick is the respective subdirectories cannot be blindly deleted because some of them are NOT duplicated in the respective parent directory. The best approach is to MOVE those unduplicated directories up one level. Those affected modules include:

tde-i18n-hu
  Move visualdict up one level

tde-i18n-ja
  Move faq up one level

tde-i18n-sk
  Move faq up one level
  Move glossary up one level
  Move quickstart up one level
  Move userguide up one level
  Move visualdict up one level

tde-i18n-sl
  Move faq up one level
  Move glossary up one level
  Move userguide up one level
  Move visualdict up one level

tde-i18n-tr
  Move faq up one level

I'm testing a preliminary patch. Thereafter I have to learn the appropriate way to delete files and directories the GIT way because a "diff -urNa" patch performs the correct changes but does not inform GIT of what was deleted or added. Using 'git add *' resolves part of the changes for directories that were moved, but I still have to inform GIT of what files and directories were deleted permanently.

Patch pushed in commit 7db92886.

This resolves the report.

Thank you for reporting!

Darrell, great job! This allow to go ahead in the conversion of tde-i18n to cmake.

Note: For git instead of "git add *" and "git rm" I always recommend using "git add --all" because this solve everything - adding and also deleting.

Please update your local repo and perform a full tde-i18n rebuild to ensure I pushed everything correctly. :-)

After testing I merged my patch to my local repo and then performed git add *, which seemed to catch the removals as well, but somebody else should verify all is well.

Comment 5 lists the nine affected locales and the five that had directories moved rather than deleted.

I pushed some other tde-i18n patches that updated all files with the recent renaming changes. There was a lot of breakage. Updating took a few days because of the size of the module. Chances are good I missed some of the renaming changes.

As I do not speak or use additional languages, somebody who does should spot check the help handbooks to ensure those changes are correct. :-)

Next locales are still have conflictes: sv, it, fr

The conflicts are about knemo docs are present in both tdenetwork and tdepim.

Would you please more details? I'm not following your description.

(In reply to comment #10)
> Would you please more details? I'm not following your description.

The same as before I discovered those conflicts during introducing cmake support (see new Attachment #1469 [details] to bug 1329).

The next conflicts are present in ${locale}/doc/ trees:

fr:
   quanta/kxsldbg   --  tdewebdev/kxsldbg
   tdenetwork/kmail --  tdepim/kmail
   tdenetwork/knode --  tdepim/knode
it:
   tdenetwork/korn  --  tdepim/korn
sv:
   tdenetwork/korn  --  tdepim/korn

PS: I don't remember why I mentioned knemo previously.

Okay, I see. Looks like we want to perform 'git rm -fr' on the following:

tde-i18n-fr/docs/quanta/kxsldbg
tde-i18n-fr/docs/tdenetwork/kmail
tde-i18n-fr/docs/tdenetwork/knode

./tde-i18n-hu/docs/tdenetwork/korn
./tde-i18n-it/docs/tdenetwork/korn
./tde-i18n-sv/docs/tdenetwork/korn

Does that look correct?

Probably long ago a result of an accidental drag-and-drop? Who knows. :-)

I wonder whether there is a way we can search the entire tde-i18n module for additional directories that are out-of-place.

Correction! Looks like we want to perform 'git rm -fr' on the following:

tde-i18n-fr/docs/quanta
tde-i18n-fr/docs/tdenetwork/kmail
tde-i18n-fr/docs/tdenetwork/knode
tde-i18n-it/docs/tdenetwork/korn
tde-i18n-sv/docs/tdenetwork/korn

Yet perform 'git mv':

tde-i18n-hu/docs/tdenetwork/korn -> tde-i18n-hu/docs/tdepim/korn

Does that look correct?

(In reply to comment #12)
> Okay, I see. Looks like we want to perform 'git rm -fr' on the following:
> 
> tde-i18n-fr/docs/quanta/kxsldbg
> tde-i18n-fr/docs/tdenetwork/kmail
> tde-i18n-fr/docs/tdenetwork/knode
> 
> ./tde-i18n-hu/docs/tdenetwork/korn
> ./tde-i18n-it/docs/tdenetwork/korn
> ./tde-i18n-sv/docs/tdenetwork/korn
> 
> Does that look correct?

Yes, except the ./tde-i18n-hu/docs/tdenetwork/korn should be moved to tdepim rather than deleted.

> Probably long ago a result of an accidental drag-and-drop? Who knows. :-)
> 
Seems a long time ago, those programs was part of kdenetwork package before kdepim was introduced (should be the history of KDE-3.2 times). Some translators just haven't noticed that and translated moved document as they were new.

> I wonder whether there is a way we can search the entire tde-i18n module for
> additional directories that are out-of-place.
We can compare the lists of directories in doc subdirs of the module and in the tde-i18n package. If directory is present in tde-i18n and not present in main module it supposed to be suspicious.

Created attachment 1471 [details]
List of suspicios documentation

Here is a list of documentation that present in translation but doesn't present in main modules.

I've used next script to produce it:
============================================
find */docs/ -maxdepth 2 -mindepth 2 -type d | while read d; do 
  app=$(basename $d); 
  mod=$(basename $(dirname $d)); 
  if [ ! -d ../${mod}/doc/${app} ]; then 
    moved="$(find ../*/doc/ -type d  -iname $app | head -n1)"; 
    moved="${moved#../}"; 
    moved=${moved/doc\//}; 
    if [ -n "$moved" ]; then 
      echo -e "$d\t->\t$moved"; else echo $d; 
    fi; 
  fi; 
done | column -t >/tmp/list-of-docs
============================================

Ok. Your Comment 14 agrees my Comment 13. :-)

I performed a cursory review of the duplicate docbook files. I can't read the other languages but the dates in the docbook files located in the appropriate directories are more recent and therefore, those docbook files likely are the correct/current docbook file. Just guessing, of course.

I pushed to git the following changes in commit 649de03e:

git rm -fr tde-i18n-es/docs/quanta

git rm -fr tde-i18n-fr/docs/quanta
git rm -fr tde-i18n-fr/docs/tdenetwork/kmail
git rm -fr tde-i18n-fr/docs/tdenetwork/knode

git rm -fr tde-i18n-it/docs/tdenetwork/korn

git rm -fr tde-i18n-sv/docs/tdenetwork/korn

git mv tde-i18n-hu/docs/tdenetwork/korn tde-i18n-hu/docs/tdepim/korn

With those patches pushed, your script now reveals "potential" duplicates of kcontrol docbook files. I have not investigated whether the kcontrol directories are actual duplicates or just happen to be directories with the same name in different locations.

tde-i18n-ca/docs/tdepim/kcontrol                 ->  tdebase/kcontrol
tde-i18n-ca/docs/tdemultimedia/kcontrol          ->  tdebase/kcontrol
tde-i18n-cs/docs/tdemultimedia/kcontrol          ->  tdebase/kcontrol
tde-i18n-en_GB/docs/tdepim/kcontrol              ->  tdebase/kcontrol
tde-i18n-en_GB/docs/tdemultimedia/kcontrol       ->  tdebase/kcontrol
tde-i18n-et/docs/tdepim/kcontrol                 ->  tdebase/kcontrol
tde-i18n-et/docs/tdemultimedia/kcontrol          ->  tdebase/kcontrol
tde-i18n-fr/docs/tdepim/kcontrol                 ->  tdebase/kcontrol
tde-i18n-fr/docs/tdemultimedia/kcontrol          ->  tdebase/kcontrol
tde-i18n-hu/docs/tdepim/kcontrol                 ->  tdebase/kcontrol
tde-i18n-hu/docs/tdemultimedia/kcontrol          ->  tdebase/kcontrol
tde-i18n-it/docs/tdepim/kcontrol                 ->  tdebase/kcontrol
tde-i18n-ja/docs/tdepim/kcontrol                 ->  tdebase/kcontrol
tde-i18n-ja/docs/tdemultimedia/kcontrol          ->  tdebase/kcontrol
tde-i18n-nl/docs/tdepim/kcontrol                 ->  tdebase/kcontrol
tde-i18n-nl/docs/tdemultimedia/kcontrol          ->  tdebase/kcontrol
tde-i18n-pt/docs/tdepim/kcontrol                 ->  tdebase/kcontrol
tde-i18n-pt/docs/tdemultimedia/kcontrol          ->  tdebase/kcontrol
tde-i18n-pt_BR/docs/tdemultimedia/kcontrol       ->  tdebase/kcontrol
tde-i18n-sk/docs/tdepim/kcontrol                 ->  tdebase/kcontrol
tde-i18n-sk/docs/tdemultimedia/kcontrol          ->  tdebase/kcontrol
tde-i18n-sl/docs/tdepim/kcontrol                 ->  tdebase/kcontrol
tde-i18n-sl/docs/tdemultimedia/kcontrol          ->  tdebase/kcontrol
tde-i18n-sv/docs/tdepim/kcontrol                 ->  tdebase/kcontrol
tde-i18n-sv/docs/tdemultimedia/kcontrol          ->  tdebase/kcontrol

> With those patches pushed, your script now reveals "potential" duplicates of
> kcontrol docbook files. I have not investigated whether the kcontrol
> directories are actual duplicates or just happen to be directories with the
> same name in different locations.
They are not really duplicates, or moves... it's just a side effect of my crappy oneliner. In tdepim kcontrol contains kcontrol/kalarmd documentation, I suspect it moved to kalarm directory. In tdemultimedia there is quite the same story about kmix. But I haven't inspected it deeply, so it's just guess as well.

If you are satisfied then please close the report as resolved. :-)

Darrell, you forgot to update paths in configure.in's.

Ok. How was I to know that. :-) Shrug.

Ok. In progress....

Ok. Try again. Commit 5607d131.

(In reply to comment #21)
> Ok. Try again. Commit 5607d131.

seems to be ok now... 
 RESOLVED FIXED

there are some other issues like tdeutils/{k -> t}delirc rename and other, but let's leave it as is and resolve 1329 at first.
I'll open a new bug for next time.