[latex3-commits] [git/LaTeX3-latex3-l3build] ctan-post: first stab at documenting "upload" (ed59941)

[Will Robertson]

Repository : https://github.com/latex3/l3build
On branch  : ctan-post
Link       : https://github.com/latex3/l3build/commit/ed59941754627ef94db8f2b80bb1c3f089c378b5

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

commit ed59941754627ef94db8f2b80bb1c3f089c378b5
Author: Will Robertson <wspr81 at gmail.com>
Date:   Tue Dec 11 22:38:10 2018 +1030

    first stab at documenting "upload"


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

ed59941754627ef94db8f2b80bb1c3f089c378b5
 l3build-upload.lua |    4 ++--
 l3build.dtx        |   40 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 42 insertions(+), 2 deletions(-)

diff --git a/l3build-upload.lua b/l3build-upload.lua
index 1051e85..7f16ba4 100644
--- a/l3build-upload.lua
+++ b/l3build-upload.lua
@@ -75,13 +75,13 @@ function upload()
   ctan_field("email",        uploaddata.email,         255, "Email of uploader",                   true,  false )
   ctan_field("uploader",     uploaddata.uploader,      255, "Name of uploader",                    true,  false )
   ctan_field("ctanPath",     uploaddata.ctanPath,      255, "CTAN path",                           false, false )
-  ctan_field("license",      uploaddata.license,      2048, "Package license(s); see https://ctan.org/license", true,  true )
+  ctan_field("license",      uploaddata.license,      2048, "Package license(s)",                  true,  true )
   ctan_field("home",         uploaddata.home,          255, "URL of home page",                    false, false )
   ctan_field("bugtracker",   uploaddata.bugtracker,    255, "URL of bug tracker",                  false, false )
   ctan_field("support",      uploaddata.support,       255, "URL of support channels",             false, true  )
   ctan_field("repository",   uploaddata.repository,    255, "URL of source repositories",          false, true  )
   ctan_field("development",  uploaddata.development,   255, "URL of development channels",         false, true  )
-  ctan_field("update",       uploaddata.update,          8, "Boolean: true for an update false otherwise",     false, false )
+  ctan_field("update",       uploaddata.update,          8, "True for an update, false for a new package", false, false )
   ctan_field("topic",        uploaddata.topic,        1024, "Topic(s); see https://ctan.org/topics/highscore", false, true  )
   ctan_field("announcement", uploaddata.announcement, 8192, "Announcement",                        false, false )
   ctan_field("summary",      uploaddata.summary,       128, "One-line summary of package",         true,  false ) -- ctan-o-mat doc says optional
diff --git a/l3build.dtx b/l3build.dtx
index 4104b79..91ae22d 100644
--- a/l3build.dtx
+++ b/l3build.dtx
@@ -548,6 +548,46 @@
 % By default this process allows files to be accessed in all standard |texmf| trees; this can be disabled by setting \var{unpacksearch} to |false|.
 % \end{buildcmd}
 %
+% \begin{buildcmd}{upload}
+% This target uses \texttt{curl} to upload the package zip file (created using \texttt{ctan}) to CTAN.
+% To control the metadata used to upload the package, the \texttt{uploaddata} table should be populated with a number of fields.
+% Missing required fields will result in an interactive prompt for manual entry.
+% \end{buildcmd}
+%
+% \begin{table}
+%   \def\YES{\textbullet}
+%   \caption{Fields used in the \texttt{uploaddata} setup table. Most commands require string input, but those that are indicated with `Multi' accept more than one entry using an array of strings.}
+%   \label{tab:manifest-setup}
+%   \begin{minipage}{\linewidth}
+%   \centering
+%   \begin{tabular}{lccp{8cm}}
+%     \toprule
+%     Field & Req. & Multi & Description \\
+%     \midrule
+%  \texttt{pkg         } & \YES &      & Package name                           \\
+%  \texttt{version     } & \YES &      & Package version                        \\
+%  \texttt{author      } & \YES &      & Author name                            \\
+%  \texttt{email       } & \YES &      & Email of uploader                      \\
+%  \texttt{uploader    } & \YES &      & Name of uploader                       \\
+%  \texttt{license     } & \YES & \YES & Package license(s)\footnote{See \url{https://ctan.org/license}} \\
+%  \texttt{summary     } & \YES &      & One-line summary of package            \\
+%  \midrule
+%  \texttt{description } &      &      & Short description of package           \\
+%  \texttt{topic       } &      & \YES & Topic(s)\footnote{See \url{https://ctan.org/topics/highscore}} \\
+%  \texttt{ctanPath    } &      &      & CTAN path                              \\
+%  \texttt{update      } &      &      & Boolean: True for an update, false for a new package   \\
+%  \texttt{announcement} &      &      & Announcement text                      \\
+%  \texttt{note        } &      &      & Internal note to CTAN                  \\
+%  \texttt{home        } &      &      & URL of home page                       \\
+%  \texttt{bugtracker  } &      &      & URL of bug tracker                     \\
+%  \texttt{support     } &      & \YES & URL(s) of support channels             \\
+%  \texttt{repository  } &      & \YES & URL(s) of source repositories          \\
+%  \texttt{development } &      & \YES & URL(s) of development channels         \\
+%     \bottomrule
+%   \end{tabular}
+%   \end{minipage}
+% \end{table}
+%
 % \subsection{The \texttt{build.lua} file}
 %
 % The \texttt{build.lua} file used to control \pkg{l3build} is a simple Lua file