texinfo-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

branch master updated: * doc/texi2any_api.texi (Managing Customization V


From: Patrice Dumas
Subject: branch master updated: * doc/texi2any_api.texi (Managing Customization Variables): put the 'Adding Customization Variables' node in an ignore block. Indeed, adding customization variables is currently only possible in Perl, not with XS/C, and it is unlikely to change, as to be available in C too it would need to specify a type (integer, byte or char) and add dynamically options, which would involve important changes, so it is not certain that it is worth keeping this possibility, especially since it is not used [...]
Date: Wed, 02 Oct 2024 17:25:39 -0400

This is an automated email from the git hooks/post-receive script.

pertusus pushed a commit to branch master
in repository texinfo.

The following commit(s) were added to refs/heads/master by this push:
     new ddfbce7278 * doc/texi2any_api.texi (Managing Customization Variables): 
put the 'Adding Customization Variables' node in an ignore block.  Indeed, 
adding customization variables is currently only possible in Perl, not with 
XS/C, and it is unlikely to change, as to be available in C too it would need 
to specify a type (integer, byte or char) and add dynamically options, which 
would involve important changes, so it is not certain that it is worth keeping 
this possibility, especially [...]
ddfbce7278 is described below

commit ddfbce7278892f6bb92dc0f10ff198102ddc93e8
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Sun Aug 4 11:57:54 2024 +0200

    * doc/texi2any_api.texi (Managing Customization Variables): put the
    'Adding Customization Variables' node in an ignore block.  Indeed,
    adding customization variables is currently only possible in Perl, not
    with XS/C, and it is unlikely to change, as to be available in C too
    it would need to specify a type (integer, byte or char) and add
    dynamically options, which would involve important changes, so it is
    not certain that it is worth keeping this possibility, especially
    since it is not used anwhere in Texinfo currently.
---
 ChangeLog             | 11 +++++++++++
 doc/texi2any_api.texi |  6 ++++--
 tp/Texinfo/Common.pm  |  2 ++
 tp/Texinfo/Config.pm  |  3 +++
 4 files changed, 20 insertions(+), 2 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index f34c4369f9..55a66e9567 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -4,6 +4,17 @@
        (get_converter_info_from_sv): do not error out on
        deprecated_config_directories customization hash directory key.
 
+2024-08-04  Patrice Dumas  <pertusus@free.fr>
+
+       * doc/texi2any_api.texi (Managing Customization Variables): put the
+       'Adding Customization Variables' node in an ignore block.  Indeed,
+       adding customization variables is currently only possible in Perl, not
+       with XS/C, and it is unlikely to change, as to be available in C too
+       it would need to specify a type (integer, byte or char) and add
+       dynamically options, which would involve important changes, so it is
+       not certain that it is worth keeping this possibility, especially
+       since it is not used anwhere in Texinfo currently.
+
 2024-08-04  Patrice Dumas  <pertusus@free.fr>
 
        * tp/Texinfo/Convert/Converter.pm (_generic_converter_init): update
diff --git a/doc/texi2any_api.texi b/doc/texi2any_api.texi
index 81ce3bbfc6..ba7d759e89 100644
--- a/doc/texi2any_api.texi
+++ b/doc/texi2any_api.texi
@@ -332,7 +332,7 @@ the names of the customization options.}.
 @cindex Customization variables, setting and getting
 
 The basic operations on customization variables are to set and
-retrieve their values.  You can also add new variables.
+retrieve their values.  @c You can also add new variables.
 
 The customization variables also valid in the main program out of the HTML
 converter are handled differently if their associated values are strings or
@@ -470,6 +470,8 @@ if (texinfo_get_conf('footnotestyle') eq 'separate') @{ ... 
@}
 @end example
 
 
+@ignore
+@c problematic for XS, need a type, to add dynamically...
 @node Adding Customization Variables
 @subsection Adding Customization Variables
 
@@ -486,7 +488,7 @@ variable, call 
@code{texinfo_add_valid_customization_option}:
 
 The variable value, if set, should also be available in the converters and 
therefore
 in the init file functions registered and called from the converters.
-
+@end ignore
 
 @node Init File Loading Error Reporting
 @section Init File Loading Error Reporting
diff --git a/tp/Texinfo/Common.pm b/tp/Texinfo/Common.pm
index 92ec5d827f..8f3dd8a578 100644
--- a/tp/Texinfo/Common.pm
+++ b/tp/Texinfo/Common.pm
@@ -259,6 +259,8 @@ sub valid_customization_option($)
 
 # not documented on purpose, should not be directly called in user-defined
 # codes
+# FIXME not implementable in XS, would need a type, dynamically added
+# customization variables...
 sub add_valid_customization_option($)
 {
   my $option = shift;
diff --git a/tp/Texinfo/Config.pm b/tp/Texinfo/Config.pm
index 8d9f7c43be..06db2f8dd8 100644
--- a/tp/Texinfo/Config.pm
+++ b/tp/Texinfo/Config.pm
@@ -375,6 +375,9 @@ sub texinfo_get_conf($)
 }
 
 # to dynamically add customization options from init files
+# FIXME not implementable in XS, would need a type, dynamically added
+# customization variables...
+# Documentation in texi2any api manual is ignored.
 sub texinfo_add_valid_customization_option($)
 {
   my $option = shift;



reply via email to

[Prev in Thread] Current Thread [Next in Thread]