[latex3-commits] [git/LaTeX3-latex3-latex3] clear-drop: Rename \vbox_unpack_clear:N as _drop (ac04322)

Joseph Wright joseph.wright at morningstar2.co.uk
Thu Jan 17 21:46:03 CET 2019 

Repository : https://github.com/latex3/latex3
On branch  : clear-drop
Link       : https://github.com/latex3/latex3/commit/ac04322d5f311dfb6187579ad068d4c54386edba

>---------------------------------------------------------------

commit ac04322d5f311dfb6187579ad068d4c54386edba
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Thu Jan 17 20:42:43 2019 +0000

    Rename \vbox_unpack_clear:N as _drop


>---------------------------------------------------------------

ac04322d5f311dfb6187579ad068d4c54386edba
 l3kernel/l3box.dtx                      |   40 +++++++++++++++++++------------
 l3kernel/l3doc.dtx                      |    4 ++--
 l3kernel/testfiles/m3box003.lvt         |    4 ++--
 l3kernel/testfiles/m3expl001.luatex.tlg |    6 +++--
 l3kernel/testfiles/m3expl001.ptex.tlg   |    6 +++--
 l3kernel/testfiles/m3expl001.tlg        |    6 +++--
 l3kernel/testfiles/m3expl001.uptex.tlg  |    6 +++--
 l3kernel/testfiles/m3expl001.xetex.tlg  |    6 +++--
 l3kernel/testfiles/m3expl003.luatex.tlg |    6 +++--
 l3kernel/testfiles/m3expl003.ptex.tlg   |    6 +++--
 l3kernel/testfiles/m3expl003.tlg        |    6 +++--
 l3kernel/testfiles/m3expl003.uptex.tlg  |    6 +++--
 l3kernel/testfiles/m3expl003.xetex.tlg  |    6 +++--
 l3trial/xfont/xfss.dtx                  |    2 +-
 14 files changed, 70 insertions(+), 40 deletions(-)

diff --git a/l3kernel/l3box.dtx b/l3kernel/l3box.dtx
index b031bac..4c6e65d 100644
--- a/l3kernel/l3box.dtx
+++ b/l3kernel/l3box.dtx
@@ -553,18 +553,6 @@
 %   \end{texnote}
 % \end{function}
 %
-% \begin{function}{\vbox_unpack_clear:N, \vbox_unpack_clear:c}
-%   \begin{syntax}
-%     \cs{vbox_unpack:N} \meta{box}
-%   \end{syntax}
-%   Unpacks the content of the vertical \meta{box}, retaining any stretching
-%   or shrinking applied when the \meta{box} was set. The \meta{box}
-%   is then cleared globally.
-%   \begin{texnote}
-%     This is the \TeX{} primitive \tn{unvbox}.
-%   \end{texnote}
-% \end{function}
-%
 % \section{Using boxes efficiently}
 %
 % The functions above for using box contents work in exactly the same
@@ -640,6 +628,19 @@
 %   \end{texnote}
 % \end{function}
 %
+% \begin{function}[added = 2019-01-17]
+%   {\vbox_unpack_drop:N, \vbox_unpack_drop:c}
+%   \begin{syntax}
+%     \cs{vbox_unpack_drop:N} \meta{box}
+%   \end{syntax}
+%   Unpacks the content of the vertical \meta{box}, retaining any stretching
+%   or shrinking applied when the \meta{box} was set. The original \meta{box}
+%   is then dropped.
+%   \begin{texnote}
+%     This is the \TeX{} primitive \tn{unvbox}.
+%   \end{texnote}
+% \end{function}
+%
 % \section{Affine transformations}
 %
 % Affine transformations are changes which (informally) preserve straight
@@ -1540,14 +1541,14 @@
 % \end{macro}
 %
 % \begin{macro}{\vbox_unpack:N, \vbox_unpack:c}
-% \begin{macro}{\vbox_unpack_clear:N, \vbox_unpack_clear:c}
+% \begin{macro}{\vbox_unpack_drop:N, \vbox_unpack_drop:c}
 % \testfile*
 %   Unpacking a box and if requested also clear it.
 %    \begin{macrocode}
 \cs_new_eq:NN \vbox_unpack:N \tex_unvcopy:D
-\cs_new_eq:NN \vbox_unpack_clear:N \tex_unvbox:D
+\cs_new_eq:NN \vbox_unpack_drop:N \tex_unvbox:D
 \cs_generate_variant:Nn \vbox_unpack:N { c }
-\cs_generate_variant:Nn \vbox_unpack_clear:N { c }
+\cs_generate_variant:Nn \vbox_unpack_drop:N { c }
 %    \end{macrocode}
 % \end{macro}
 % \end{macro}
@@ -2145,6 +2146,15 @@
 %    \end{macrocode}
 % \end{macro}
 %
+% \begin{macro}{\vbox_unpack_clear:N, \vbox_unpack_clear:c}
+%    \begin{macrocode}
+\__kernel_patch_deprecation:nnNNpn { 2020-12-31 } { \vbox_unpack_drop:N }
+\cs_new_protected:Npn \vbox_unpack_clear:N
+  { \vbox_unpack_drop:N }
+\cs_generate_variant:Nn \vbox_unpack_clear:N { c }
+%    \end{macrocode}
+% \end{macro}
+%
 %    \begin{macrocode}
 %</initex|package>
 %    \end{macrocode}
diff --git a/l3kernel/l3doc.dtx b/l3kernel/l3doc.dtx
index 8e511c7..15e1d61 100644
--- a/l3kernel/l3doc.dtx
+++ b/l3kernel/l3doc.dtx
@@ -2989,7 +2989,7 @@ and all files in that bundle must be distributed together.
             \hbox_unpack_drop:N \l_@@_macro_index_box
             \vtop to \baselineskip
               {
-                \vbox_unpack_clear:N \l_@@_macro_box
+                \vbox_unpack_drop:N \l_@@_macro_box
                 \vss
               }
           }
@@ -3075,7 +3075,7 @@ and all files in that bundle must be distributed together.
   {
     \vbox_set:Nn \l_@@_macro_box
       {
-        \vbox_unpack_clear:N \l_@@_macro_box
+        \vbox_unpack_drop:N \l_@@_macro_box
         \hbox { \llap { \@@_print_macroname:nN {#1} #2 \ } }
       }
     \int_incr:N \l_@@_macro_int
diff --git a/l3kernel/testfiles/m3box003.lvt b/l3kernel/testfiles/m3box003.lvt
index 11c8b7b..f62ab18 100644
--- a/l3kernel/testfiles/m3box003.lvt
+++ b/l3kernel/testfiles/m3box003.lvt
@@ -77,8 +77,8 @@
   \box_show:N \l_tempa_box
   \box_show:N \l_tempb_box
   \group_begin:
-    \vbox_unpack_clear:N \l_tempa_box
-    \vbox_unpack_clear:c {l_tempb_box}
+    \vbox_unpack_drop:N \l_tempa_box
+    \vbox_unpack_drop:c {l_tempb_box}
     \box_show:N \l_tempa_box
     \box_show:N \l_tempb_box
   \group_end:
diff --git a/l3kernel/testfiles/m3expl001.luatex.tlg b/l3kernel/testfiles/m3expl001.luatex.tlg
index 7112263..bf17903 100644
--- a/l3kernel/testfiles/m3expl001.luatex.tlg
+++ b/l3kernel/testfiles/m3expl001.luatex.tlg
@@ -5190,9 +5190,9 @@ Defining \vbox_gset_to_ht:Nnw on line ...
 Defining \vbox_set_to_ht:cnw on line ...
 Defining \vbox_gset_to_ht:cnw on line ...
 Defining \vbox_unpack:N on line ...
-Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_drop:N on line ...
 Defining \vbox_unpack:c on line ...
-Defining \vbox_unpack_clear:c on line ...
+Defining \vbox_unpack_drop:c on line ...
 Defining \vbox_set_split_to_ht:NNn on line ...
 Defining \vbox_set_split_to_ht:cNn on line ...
 Defining \vbox_set_split_to_ht:Ncn on line ...
@@ -5264,6 +5264,8 @@ Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
 Defining \hbox_unpack_clear:N on line ...
 Defining \hbox_unpack_clear:c on line ...
+Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...
diff --git a/l3kernel/testfiles/m3expl001.ptex.tlg b/l3kernel/testfiles/m3expl001.ptex.tlg
index 487134f..cb2ef7f 100644
--- a/l3kernel/testfiles/m3expl001.ptex.tlg
+++ b/l3kernel/testfiles/m3expl001.ptex.tlg
@@ -5486,9 +5486,9 @@ Defining \vbox_gset_to_ht:Nnw on line ...
 Defining \vbox_set_to_ht:cnw on line ...
 Defining \vbox_gset_to_ht:cnw on line ...
 Defining \vbox_unpack:N on line ...
-Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_drop:N on line ...
 Defining \vbox_unpack:c on line ...
-Defining \vbox_unpack_clear:c on line ...
+Defining \vbox_unpack_drop:c on line ...
 Defining \vbox_set_split_to_ht:NNn on line ...
 Defining \vbox_set_split_to_ht:cNn on line ...
 Defining \vbox_set_split_to_ht:Ncn on line ...
@@ -5560,6 +5560,8 @@ Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
 Defining \hbox_unpack_clear:N on line ...
 Defining \hbox_unpack_clear:c on line ...
+Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...
diff --git a/l3kernel/testfiles/m3expl001.tlg b/l3kernel/testfiles/m3expl001.tlg
index c4d5b8e..e81a7ca 100644
--- a/l3kernel/testfiles/m3expl001.tlg
+++ b/l3kernel/testfiles/m3expl001.tlg
@@ -5486,9 +5486,9 @@ Defining \vbox_gset_to_ht:Nnw on line ...
 Defining \vbox_set_to_ht:cnw on line ...
 Defining \vbox_gset_to_ht:cnw on line ...
 Defining \vbox_unpack:N on line ...
-Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_drop:N on line ...
 Defining \vbox_unpack:c on line ...
-Defining \vbox_unpack_clear:c on line ...
+Defining \vbox_unpack_drop:c on line ...
 Defining \vbox_set_split_to_ht:NNn on line ...
 Defining \vbox_set_split_to_ht:cNn on line ...
 Defining \vbox_set_split_to_ht:Ncn on line ...
@@ -5560,6 +5560,8 @@ Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
 Defining \hbox_unpack_clear:N on line ...
 Defining \hbox_unpack_clear:c on line ...
+Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...
diff --git a/l3kernel/testfiles/m3expl001.uptex.tlg b/l3kernel/testfiles/m3expl001.uptex.tlg
index 3735173..dc2bf95 100644
--- a/l3kernel/testfiles/m3expl001.uptex.tlg
+++ b/l3kernel/testfiles/m3expl001.uptex.tlg
@@ -5483,9 +5483,9 @@ Defining \vbox_gset_to_ht:Nnw on line ...
 Defining \vbox_set_to_ht:cnw on line ...
 Defining \vbox_gset_to_ht:cnw on line ...
 Defining \vbox_unpack:N on line ...
-Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_drop:N on line ...
 Defining \vbox_unpack:c on line ...
-Defining \vbox_unpack_clear:c on line ...
+Defining \vbox_unpack_drop:c on line ...
 Defining \vbox_set_split_to_ht:NNn on line ...
 Defining \vbox_set_split_to_ht:cNn on line ...
 Defining \vbox_set_split_to_ht:Ncn on line ...
@@ -5557,6 +5557,8 @@ Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
 Defining \hbox_unpack_clear:N on line ...
 Defining \hbox_unpack_clear:c on line ...
+Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...
diff --git a/l3kernel/testfiles/m3expl001.xetex.tlg b/l3kernel/testfiles/m3expl001.xetex.tlg
index 742abcf..b98ccd0 100644
--- a/l3kernel/testfiles/m3expl001.xetex.tlg
+++ b/l3kernel/testfiles/m3expl001.xetex.tlg
@@ -5201,9 +5201,9 @@ Defining \vbox_gset_to_ht:Nnw on line ...
 Defining \vbox_set_to_ht:cnw on line ...
 Defining \vbox_gset_to_ht:cnw on line ...
 Defining \vbox_unpack:N on line ...
-Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_drop:N on line ...
 Defining \vbox_unpack:c on line ...
-Defining \vbox_unpack_clear:c on line ...
+Defining \vbox_unpack_drop:c on line ...
 Defining \vbox_set_split_to_ht:NNn on line ...
 Defining \vbox_set_split_to_ht:cNn on line ...
 Defining \vbox_set_split_to_ht:Ncn on line ...
@@ -5275,6 +5275,8 @@ Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
 Defining \hbox_unpack_clear:N on line ...
 Defining \hbox_unpack_clear:c on line ...
+Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...
diff --git a/l3kernel/testfiles/m3expl003.luatex.tlg b/l3kernel/testfiles/m3expl003.luatex.tlg
index 7112263..bf17903 100644
--- a/l3kernel/testfiles/m3expl003.luatex.tlg
+++ b/l3kernel/testfiles/m3expl003.luatex.tlg
@@ -5190,9 +5190,9 @@ Defining \vbox_gset_to_ht:Nnw on line ...
 Defining \vbox_set_to_ht:cnw on line ...
 Defining \vbox_gset_to_ht:cnw on line ...
 Defining \vbox_unpack:N on line ...
-Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_drop:N on line ...
 Defining \vbox_unpack:c on line ...
-Defining \vbox_unpack_clear:c on line ...
+Defining \vbox_unpack_drop:c on line ...
 Defining \vbox_set_split_to_ht:NNn on line ...
 Defining \vbox_set_split_to_ht:cNn on line ...
 Defining \vbox_set_split_to_ht:Ncn on line ...
@@ -5264,6 +5264,8 @@ Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
 Defining \hbox_unpack_clear:N on line ...
 Defining \hbox_unpack_clear:c on line ...
+Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...
diff --git a/l3kernel/testfiles/m3expl003.ptex.tlg b/l3kernel/testfiles/m3expl003.ptex.tlg
index 487134f..cb2ef7f 100644
--- a/l3kernel/testfiles/m3expl003.ptex.tlg
+++ b/l3kernel/testfiles/m3expl003.ptex.tlg
@@ -5486,9 +5486,9 @@ Defining \vbox_gset_to_ht:Nnw on line ...
 Defining \vbox_set_to_ht:cnw on line ...
 Defining \vbox_gset_to_ht:cnw on line ...
 Defining \vbox_unpack:N on line ...
-Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_drop:N on line ...
 Defining \vbox_unpack:c on line ...
-Defining \vbox_unpack_clear:c on line ...
+Defining \vbox_unpack_drop:c on line ...
 Defining \vbox_set_split_to_ht:NNn on line ...
 Defining \vbox_set_split_to_ht:cNn on line ...
 Defining \vbox_set_split_to_ht:Ncn on line ...
@@ -5560,6 +5560,8 @@ Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
 Defining \hbox_unpack_clear:N on line ...
 Defining \hbox_unpack_clear:c on line ...
+Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...
diff --git a/l3kernel/testfiles/m3expl003.tlg b/l3kernel/testfiles/m3expl003.tlg
index c4d5b8e..e81a7ca 100644
--- a/l3kernel/testfiles/m3expl003.tlg
+++ b/l3kernel/testfiles/m3expl003.tlg
@@ -5486,9 +5486,9 @@ Defining \vbox_gset_to_ht:Nnw on line ...
 Defining \vbox_set_to_ht:cnw on line ...
 Defining \vbox_gset_to_ht:cnw on line ...
 Defining \vbox_unpack:N on line ...
-Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_drop:N on line ...
 Defining \vbox_unpack:c on line ...
-Defining \vbox_unpack_clear:c on line ...
+Defining \vbox_unpack_drop:c on line ...
 Defining \vbox_set_split_to_ht:NNn on line ...
 Defining \vbox_set_split_to_ht:cNn on line ...
 Defining \vbox_set_split_to_ht:Ncn on line ...
@@ -5560,6 +5560,8 @@ Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
 Defining \hbox_unpack_clear:N on line ...
 Defining \hbox_unpack_clear:c on line ...
+Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...
diff --git a/l3kernel/testfiles/m3expl003.uptex.tlg b/l3kernel/testfiles/m3expl003.uptex.tlg
index 3735173..dc2bf95 100644
--- a/l3kernel/testfiles/m3expl003.uptex.tlg
+++ b/l3kernel/testfiles/m3expl003.uptex.tlg
@@ -5483,9 +5483,9 @@ Defining \vbox_gset_to_ht:Nnw on line ...
 Defining \vbox_set_to_ht:cnw on line ...
 Defining \vbox_gset_to_ht:cnw on line ...
 Defining \vbox_unpack:N on line ...
-Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_drop:N on line ...
 Defining \vbox_unpack:c on line ...
-Defining \vbox_unpack_clear:c on line ...
+Defining \vbox_unpack_drop:c on line ...
 Defining \vbox_set_split_to_ht:NNn on line ...
 Defining \vbox_set_split_to_ht:cNn on line ...
 Defining \vbox_set_split_to_ht:Ncn on line ...
@@ -5557,6 +5557,8 @@ Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
 Defining \hbox_unpack_clear:N on line ...
 Defining \hbox_unpack_clear:c on line ...
+Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...
diff --git a/l3kernel/testfiles/m3expl003.xetex.tlg b/l3kernel/testfiles/m3expl003.xetex.tlg
index 742abcf..b98ccd0 100644
--- a/l3kernel/testfiles/m3expl003.xetex.tlg
+++ b/l3kernel/testfiles/m3expl003.xetex.tlg
@@ -5201,9 +5201,9 @@ Defining \vbox_gset_to_ht:Nnw on line ...
 Defining \vbox_set_to_ht:cnw on line ...
 Defining \vbox_gset_to_ht:cnw on line ...
 Defining \vbox_unpack:N on line ...
-Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_drop:N on line ...
 Defining \vbox_unpack:c on line ...
-Defining \vbox_unpack_clear:c on line ...
+Defining \vbox_unpack_drop:c on line ...
 Defining \vbox_set_split_to_ht:NNn on line ...
 Defining \vbox_set_split_to_ht:cNn on line ...
 Defining \vbox_set_split_to_ht:Ncn on line ...
@@ -5275,6 +5275,8 @@ Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
 Defining \hbox_unpack_clear:N on line ...
 Defining \hbox_unpack_clear:c on line ...
+Defining \vbox_unpack_clear:N on line ...
+Defining \vbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...
diff --git a/l3trial/xfont/xfss.dtx b/l3trial/xfont/xfss.dtx
index 0bec7af..543a9bc 100644
--- a/l3trial/xfont/xfss.dtx
+++ b/l3trial/xfont/xfss.dtx
@@ -567,7 +567,7 @@
 %   \LaTeXe's \cs{leavevmode} and \cs{mbox}
 %    \begin{macrocode}
  % \cs_new_protected:Npn \mode_leave_vertical:
- %   { \hbox_unpack_clear:N \c_empty_box }
+ %   { \hbox_unpack_drop:N \c_empty_box }
 \cs_if_free:NT \xfss_text_in_math:n
   {
     \cs_new_protected:Npn \xfss_text_in_math:n

More information about the latex3-commits mailing list