Uploaded image for project: 'SWORD'
  1. SWORD
  2. API-213

which utilities to really install? was missing man page

    Details

    • Type: Improvement
    • Status: Reopened (View Workflow)
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      Description

      The binary "stripaccents" does not have an accompanying manpage.

       

      Debian warns for this:

      W: libsword-utils: binary-without-manpage usr/bin/stripaccents

        Attachments

          Activity

          Hide
          scribe Troy A Griffitts added a comment -

          Hmmm.  I would guess after stripaccents, they will probably complain about all the other utils not having man pages (unless someone actually wrote man pages for the others and I am unaware!)  I doubt all the utils in sword/utils/ are useful to be installed globally at /usr/bin.  installmgr, diatheke, osis2mod, ld2mod, vs2mod and few others for module makers are likely the only ones we probably want to install.  I just assumed people who needed the utils would install from source.  I guess that's not a good assumption.  Specifically on this ticket, I doubt stripaccents is useful for anyone.  Thoughts?

          Show
          scribe Troy A Griffitts added a comment - Hmmm.  I would guess after stripaccents, they will probably complain about all the other utils not having man pages (unless someone actually wrote man pages for the others and I am unaware!)  I doubt all the utils in sword/utils/ are useful to be installed globally at /usr/bin.  installmgr, diatheke, osis2mod, ld2mod, vs2mod and few others for module makers are likely the only ones we probably want to install.  I just assumed people who needed the utils would install from source.  I guess that's not a good assumption.  Specifically on this ticket, I doubt stripaccents is useful for anyone.  Thoughts?
          Hide
          teusbenschop Teus Benschop added a comment -

          It looks like Debian complains about strip accents only. All others it is numb about. When compiling the package I see a large swath of man pages being produced. Guess somebody wrote them. 

           

          Alternately I can silence the warning about the missing man page about stripaccents. I don't mind at all.

          Show
          teusbenschop Teus Benschop added a comment - It looks like Debian complains about strip accents only. All others it is numb about. When compiling the package I see a large swath of man pages being produced. Guess somebody wrote them.    Alternately I can silence the warning about the missing man page about stripaccents. I don't mind at all.
          Hide
          refdoc Peter von Kaehne added a comment -

          Stripaccents is in sword/examples. It is not a utility function. Nothing in the sword/examples directory should be packaged. If it was so useful that others wanted it as a utility, then a bug should be filed against its location, it should be moved to utilities and then maybe a man page would be useful. I wrote the function in order to learn and then to document how to strip accents. I then used the skills to improve on my Perl module creation scripts. I left the example there because it is useful as a coding example, but nothing else.

          Please simply remove stripaccents from your packaging (and anything else in sword/examples). If anyone moans ask them to file a bug against the location of the function.

          I will close this bug

          Show
          refdoc Peter von Kaehne added a comment - Stripaccents is in sword/examples. It is not a utility function. Nothing in the sword/examples directory should be packaged. If it was so useful that others wanted it as a utility, then a bug should be filed against its location, it should be moved to utilities and then maybe a man page would be useful. I wrote the function in order to learn and then to document how to strip accents. I then used the skills to improve on my Perl module creation scripts. I left the example there because it is useful as a coding example, but nothing else. Please simply remove stripaccents from your packaging (and anything else in sword/examples). If anyone moans ask them to file a bug against the location of the function. I will close this bug
          Hide
          refdoc Peter von Kaehne added a comment -

          stripaccents should never be packaged. It is a coding example. If anyone finds it useful, they should file a bug against its location and ask for it to be moved to sword/utilities. Until then....

          Show
          refdoc Peter von Kaehne added a comment - stripaccents should never be packaged. It is a coding example. If anyone finds it useful, they should file a bug against its location and ask for it to be moved to sword/utilities. Until then....
          Hide
          glasseyes Daniel Glassey added a comment -

          Hi Peter,

          stripaccents is already in utilties. That is why it is getting installed in the Debian packaging.

          It'd confusing because it is in examples as well.

          `tar tfz ../sword_1.8.1.orig.tar.gz|grep stripacc
          sword-1.8.1/examples/cmdline/stripaccents.cpp
          sword-1.8.1/utilities/stripaccents.cpp`

          Troy - source is how packages are made! If the utility is only for local use building from source and not to be installed on the system then it can go in noinst_PROGRAMS in the utilties/Makefile.am. Some are already in there.

          currently the installed utilities are:

          bin_PROGRAMS = mod2imp mod2osis osis2mod tei2mod vs2osisref vs2osisreftxt \
          mod2vpl mkfastmod vpl2mod imp2vs installmgr xml2gbs imp2gbs imp2ld \
          stripaccents emptyvss

          and for some reason someone added addld to the Debian package, possibly because it used to be installed

          Which of those should be installed in the package, and which are to be ignored? We can make that change in the packaging.

          Show
          glasseyes Daniel Glassey added a comment - Hi Peter, stripaccents is already in utilties. That is why it is getting installed in the Debian packaging. It'd confusing because it is in examples as well. `tar tfz ../sword_1.8.1.orig.tar.gz|grep stripacc sword-1.8.1/examples/cmdline/stripaccents.cpp sword-1.8.1/utilities/stripaccents.cpp` Troy - source is how packages are made! If the utility is only for local use building from source and not to be installed on the system then it can go in noinst_PROGRAMS in the utilties/Makefile.am. Some are already in there. currently the installed utilities are: bin_PROGRAMS = mod2imp mod2osis osis2mod tei2mod vs2osisref vs2osisreftxt \ mod2vpl mkfastmod vpl2mod imp2vs installmgr xml2gbs imp2gbs imp2ld \ stripaccents emptyvss and for some reason someone added addld to the Debian package, possibly because it used to be installed Which of those should be installed in the package, and which are to be ignored? We can make that change in the packaging.
          Hide
          refdoc Peter von Kaehne added a comment -

          I have now removed stripaccents from utilities. I think the rest is ok and should remain part of the utilties.

          There are also now man pages within the actual project source. The ones you had in the past are actually part of Debian's patch set. I have imported them, transformed them into Roff and started updating them - they were mostly quite badly out of date. This is not entirely complete in SVN Head as some commit needs to happen to the main Makefile.am and config.ac - I do not have the rights for that.

          Show
          refdoc Peter von Kaehne added a comment - I have now removed stripaccents from utilities. I think the rest is ok and should remain part of the utilties. There are also now man pages within the actual project source. The ones you had in the past are actually part of Debian's patch set. I have imported them, transformed them into Roff and started updating them - they were mostly quite badly out of date. This is not entirely complete in SVN Head as some commit needs to happen to the main Makefile.am and config.ac - I do not have the rights for that.
          Hide
          greg.hellings Greg Hellings added a comment -

          This will also need updating in the CMakeLists.txt files to remove stripaccents and to add handling the man pages.

          Show
          greg.hellings Greg Hellings added a comment - This will also need updating in the CMakeLists.txt files to remove stripaccents and to add handling the man pages.

            People

            • Assignee:
              Unassigned
              Reporter:
              teusbenschop Teus Benschop
            • Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

              • Created:
                Updated: