Changeset 3259d7 in git


Ignore:
Timestamp:
Jul 19, 2021, 12:05:53 AM (3 years ago)
Author:
Michael Orlitzky <michael@…>
Branches:
(u'spielwiese', 'fe61d9c35bf7c61f2b6cbf1b56e25e2f08d536cc')
Children:
1362e6105131ed9d59ba96909ca0f4ba4b56c218
Parents:
1a010f4c0c6ebc290bbd35834683e4c4f52a0846
git-author:
Michael Orlitzky <michael@orlitzky.com>2021-07-18 18:05:53-04:00
git-committer:
Michael Orlitzky <michael@orlitzky.com>2021-07-18 18:19:31-04:00
Message:
**/*: rename singular.hlp to singular.info.

The help file presently named "singular.hlp" is intended to be read
with GNU Info, which looks for an extension of ".info" by
default. Thus, at the moment, one must run "info singular.hlp" to read
the installed file, whereas "info singular" is more natural.

This commit replaces "singular.hlp" with "singular.info" throughout
the source tree so that the file ultimately has the name that GNU Info
or Emacs expect.

Closes: https://github.com/Singular/Singular/issues/1107
Files:
15 edited

Legend:

Unmodified
Added
Removed

  • Makefile.am

    r1a010f r3259d7  
    2020           mkdir $(DESTDIR)$(datadir)/info;\
    2121           mkdir $(DESTDIR)$(datadir)/doc;\
    22            mv  $(DESTDIR)$(datadir)/singular/singular.hlp  $(DESTDIR)$(datadir)/info/.;\
     22           mv  $(DESTDIR)$(datadir)/singular/singular.info  $(DESTDIR)$(datadir)/info/.;\
    2323        fi
    2424
    2525uninstall-local:
    26         -(cd $(DESTDIR)$(datadir); rm -rf singular info/singular.hlp)
     26        -(cd $(DESTDIR)$(datadir); rm -rf singular info/singular.info)
    2727
    2828configheaderdir = ${includedir}/singular

  • Singular/LIB/help.cnf

    r1a010f r3259d7  
    66# known requirements:
    77#  x- requires singular.idx
    8 #  i- requires singular.hlp
     8#  i- requires singular.info
    99#  h- requires html dir
    1010#  D- requires the environment variable DISPLAY
    … …  
    1818#  %H: the www html  file
    1919#             (in the form https://www.singular.uni-kl.de/some/dir/sing_123.htm)
    20 #  %i: the complete path of singular.hlp
     20#  %i: the complete path of singular.info
    2121#  %n: the info node
    2222#  %v: Singular version (in the form 4-0-0)

  • Singular/fehelp.cc

    r1a010f r3259d7  
    819819      case '#': break;
    820820      case ' ': break;
    821       case 'i': /* singular.hlp */
     821      case 'i': /* singular.info */
    822822      case 'x': /* singular.idx */
    823823      case 'h': /* html dir */
    … …  
    958958                   break;
    959959                 }
    960         case 'i': /* singular.hlp */
     960        case 'i': /* singular.info */
    961961                 {
    962962                   char *i_res=feResource('i');
    … …  
    964964                   else
    965965                   {
    966                      WarnS("singular.hlp not found");
     966                     WarnS("singular.info not found");
    967967                     return;
    968968                   }

  • doc/.gitignore

    r1a010f r3259d7  
    3232/temp*
    3333/ti_ip.tex
    34 /singular.hlp
     34/singular.info
    3535/doc.tbz2

  • doc/Makefile-docbuild.in

    r1a010f r3259d7  
    110110
    111111# info stuff
    112 info: singular.hlp
    113 
    114 singular.hlp: ${MANUAL_FILES} singular.tex s-plural.tex s-plulibs.tex s-letterplace.tex
     112info: singular.info
     113
     114singular.info: ${MANUAL_FILES} singular.tex s-plural.tex s-plulibs.tex s-letterplace.tex
    115115        - ${MAKEINFO} --no-split singular.tex
    116116
    … …  
    195195
    196196# index file for help
    197 singular.idx: singular.hlp ${HTML_SUBDIR}/${HTML_MANUAL_PREFIX}_cp.idx doc2idx.pl
    198         export PERLLIB=. PERL5LIB=.;${PERL} doc2idx.pl singular.hlp ${HTML_SUBDIR}/${HTML_MANUAL_PREFIX}_cp.idx ${CHKSUM_DB} > singular.idx
     197singular.idx: singular.info ${HTML_SUBDIR}/${HTML_MANUAL_PREFIX}_cp.idx doc2idx.pl
     198        export PERLLIB=. PERL5LIB=.;${PERL} doc2idx.pl singular.info ${HTML_SUBDIR}/${HTML_MANUAL_PREFIX}_cp.idx ${CHKSUM_DB} > singular.idx
    199199
    200200###########################################################

  • doc/Makefile.am

    r1a010f r3259d7  
    170170        /bin/rm -f *.tps *.vr *.vrs *.dvi *.ps
    171171        /bin/rm -f s-plural.tex s-plulibs.tex s-letterplace.tex
    172         /bin/rm -f singular.hlp manual.hlp singular.idx
     172        /bin/rm -f singular.info manual.hlp singular.idx
    173173        /bin/rm -rf html
    174174        /bin/rm -f cones.tex countedref.tex decodegb.tex
    … …  
    180180        $(MAKE) -j1 -f Makefile-docbuild all
    181181
    182 singular.hlp:
     182singular.info:
    183183        $(MAKE) -j1 -f Makefile-docbuild $@
    184184
    … …  
    186186EXTRA_DIST += doc.tbz2
    187187doc.tbz2:
    188         $(MAKE) -j1 -f Makefile-docbuild singular.hlp html
    189         chmod -R a+rX singular.hlp html
    190         $(AMTAR) jcf $@ singular.hlp html
     188        $(MAKE) -j1 -f Makefile-docbuild singular.info html
     189        chmod -R a+rX singular.info html
     190        $(AMTAR) jcf $@ singular.info html
    191191dist-hook:
    192192        @if [ -n "$(DOC2TEX_EXAMPLE_EXCLUSIONS)" ]; then                                        \

  • doc/STYLEGUIDE

    r1a010f r3259d7  
    3636  Bei Aenderung von (Sub)sections daran denken, die Menues auf den neuen
    3737  Stand zu bringen.
    38   Fehlerhafte @node- und @menu-Strukturen sieht man, wenn man singular.hlp
     38  Fehlerhafte @node- und @menu-Strukturen sieht man, wenn man singular.info
    3939  erzeugt.
    4040

  • doc/dir_structure

    r1a010f r3259d7  
    3333    (currently: %b/../doc/singular.idx)
    3434  - info file
    35     (currently: %b/../info/singular.hlp)
     35    (currently: %b/../info/singular.info)
    3636  - HTML
    3737    (currently: %b/../html)

  • doc/simple-make

    r1a010f r3259d7  
    3838  -top_file index.htm  singular.doc
    3939#
    40 echo "created: singular.hlp (info), singular.dvi, html/index.htm"
     40echo "created: singular.info (info), singular.dvi, html/index.htm"

  • emacs/cmpl.pl

    r1a010f r3259d7  
    1515#
    1616$Singular = "../Singular/Singular";
    17 $hlp = "../doc/singular.hlp";
     17$hlp = "../doc/singular.info";
    1818$cmpl = "cmd";
    1919$ex_dir= "../examples";

  • emacs/singular.el

    r1a010f r3259d7  
    24592459This variable is buffer-local.")
    24602460
    2461 (defconst singular-help-fall-back-file-name "singular.hlp"
     2461(defconst singular-help-fall-back-file-name "singular.info"
    24622462  "Fall-back file name of the Singular online manual.
    24632463This variable is used if the file name of the Singular online manual cannot
    … …  
    27562756      (let ((file-name (substring output (match-beginning 1) (match-end 1))))
    27572757        (singular-debug 'interactive
    2758                         (message "scan header: singular.hlp path found"))
     2758                        (message "scan header: singular.info path found"))
    27592759        ;; in any case, remove marker from output
    27602760        (setq output (replace-match "" t t output))

  • resources/feResource.cc

    r1a010f r3259d7  
    9090  {"DataDir",   'D',    feResDir,   "SINGULAR_DATA_DIR",    "%b/../share/",          (char *)""},
    9191  {"DefaultDir",'d',    feResDir,   "SINGULAR_DEFAULT_DIR",  SINGULAR_DEFAULT_DIR,  (char *)""},
    92   {"InfoFile",  'i',    feResFile,  "SINGULAR_INFO_FILE",   "%D/info/singular.hlp", (char *)""},
     92  {"InfoFile",  'i',    feResFile,  "SINGULAR_INFO_FILE",   "%D/info/singular.info", (char *)""},
    9393  {"IdxFile",   'x',    feResFile,  "SINGULAR_IDX_FILE",    "%D/singular/singular.idx",  (char *)""},
    9494  {"HtmlDir",   'h',    feResDir,   "SINGULAR_HTML_DIR",    "%D/singular/html",              (char *)""},
Note: See TracChangeset for help on using the changeset viewer.