]> git.ipfire.org Git - thirdparty/cups.git/commitdiff
Clean up versioning and API documentation.
authorMichael R Sweet <michael.r.sweet@gmail.com>
Fri, 23 Aug 2019 15:16:26 +0000 (11:16 -0400)
committerMichael R Sweet <michael.r.sweet@gmail.com>
Fri, 23 Aug 2019 15:16:26 +0000 (11:16 -0400)
cups/dest-options.c
cups/encode.c
cups/tls-darwin.c
cups/tls-darwin.h [new file with mode: 0644]
cups/versioning.h
doc/help/cupspm.epub
doc/help/cupspm.html

index f4d75105ccbbc2742d4efeda4d4a1cbdb20965a7..8c5fe666c457f13353141cc4b3ba5d7de1b1162b 100644 (file)
@@ -59,7 +59,7 @@ static void           cups_update_ready(http_t *http, cups_dinfo_t *dinfo);
 /*
  * 'cupsAddDestMediaOptions()' - Add the option corresponding to the specified media size.
  *
- * @since CUPS 2.3@
+ * @since CUPS 2.3/macOS 10.14@
  */
 
 int                                    /* O  - New number of options */
index bda910be7f230187f09bd7d70e9446558e5e3743..2469406e2f5bda69a8afd259ff08ad8bd7cb8806 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * Option encoding routines for CUPS.
  *
- * Copyright © 2007-2018 by Apple Inc.
+ * Copyright © 2007-2019 by Apple Inc.
  * Copyright © 1997-2007 by Easy Software Products.
  *
  * Licensed under Apache License v2.0.  See the file "LICENSE" for more
@@ -673,7 +673,7 @@ _cupsEncodeOption(
 /*
  * 'cupsEncodeOption()' - Encode a single option into an IPP attribute.
  *
- * @since CUPS 2.3@
+ * @since CUPS 2.3/macOS 10.14@
  */
 
 ipp_attribute_t        *                       /* O - New attribute or @code NULL@ on error */
index f18ff215fa68f9042ff86a26e344dfca3ea6e9a1..e8c4fb713f885825f68f48d4f4b45054bf72d43b 100644 (file)
  */
 
 #include <spawn.h>
-
-extern char **environ;
-
-
-#ifndef _SECURITY_VERSION_GREATER_THAN_57610_
-typedef CF_OPTIONS(uint32_t, SecKeyUsage) {
-    kSecKeyUsageAll              = 0x7FFFFFFF
-};
-#endif /* !_SECURITY_VERSION_GREATER_THAN_57610_ */
-extern const void * kSecCSRChallengePassword;
-extern const void * kSecSubjectAltName;
-extern const void * kSecCertificateKeyUsage;
-extern const void * kSecCSRBasicContraintsPathLen;
-extern const void * kSecCertificateExtensions;
-extern const void * kSecCertificateExtensionsEncoded;
-extern const void * kSecOidCommonName;
-extern const void * kSecOidCountryName;
-extern const void * kSecOidStateProvinceName;
-extern const void * kSecOidLocalityName;
-extern const void * kSecOidOrganization;
-extern const void * kSecOidOrganizationalUnit;
-extern bool SecCertificateIsValid(SecCertificateRef certificate, CFAbsoluteTime verifyTime);
-extern CFAbsoluteTime SecCertificateNotValidAfter(SecCertificateRef certificate);
-extern SecCertificateRef SecGenerateSelfSignedCertificate(CFArrayRef subject, CFDictionaryRef parameters, SecKeyRef publicKey, SecKeyRef privateKey);
-extern SecIdentityRef SecIdentityCreate(CFAllocatorRef allocator, SecCertificateRef certificate, SecKeyRef privateKey);
-
+#include "tls-darwin.h"
 
 /*
  * Constants, very secure stuff...
diff --git a/cups/tls-darwin.h b/cups/tls-darwin.h
new file mode 100644 (file)
index 0000000..ca4136e
--- /dev/null
@@ -0,0 +1,35 @@
+/*
+ * TLS support header for CUPS on macOS.
+ *
+ * Copyright © 2007-2019 by Apple Inc.
+ * Copyright © 1997-2007 by Easy Software Products, all rights reserved.
+ *
+ * Licensed under Apache License v2.0.  See the file "LICENSE" for more
+ * information.
+ */
+
+/**** This file is included from tls-darwin.c ****/
+
+extern char **environ;
+
+#ifndef _SECURITY_VERSION_GREATER_THAN_57610_
+typedef CF_OPTIONS(uint32_t, SecKeyUsage) {
+    kSecKeyUsageAll              = 0x7FFFFFFF
+};
+#endif /* !_SECURITY_VERSION_GREATER_THAN_57610_ */
+extern const void * kSecCSRChallengePassword;
+extern const void * kSecSubjectAltName;
+extern const void * kSecCertificateKeyUsage;
+extern const void * kSecCSRBasicContraintsPathLen;
+extern const void * kSecCertificateExtensions;
+extern const void * kSecCertificateExtensionsEncoded;
+extern const void * kSecOidCommonName;
+extern const void * kSecOidCountryName;
+extern const void * kSecOidStateProvinceName;
+extern const void * kSecOidLocalityName;
+extern const void * kSecOidOrganization;
+extern const void * kSecOidOrganizationalUnit;
+extern bool SecCertificateIsValid(SecCertificateRef certificate, CFAbsoluteTime verifyTime);
+extern CFAbsoluteTime SecCertificateNotValidAfter(SecCertificateRef certificate);
+extern SecCertificateRef SecGenerateSelfSignedCertificate(CFArrayRef subject, CFDictionaryRef parameters, SecKeyRef publicKey, SecKeyRef privateKey);
+extern SecIdentityRef SecIdentityCreate(CFAllocatorRef allocator, SecCertificateRef certificate, SecKeyRef privateKey);
index aae2138e840737d080942282b9e0f759a1fd5162..14c218fee0fdb65ca5273527079bdd89a4e5da6e 100644 (file)
 #    define _CUPS_API_1_7 API_AVAILABLE(macos(10.9), ios(11.0)) _CUPS_PUBLIC
 #    define _CUPS_API_2_0 API_AVAILABLE(macos(10.10), ios(11.0)) _CUPS_PUBLIC
 #    define _CUPS_API_2_2 API_AVAILABLE(macos(10.12), ios(11.0)) _CUPS_PUBLIC
-#    define _CUPS_API_2_2_4 API_AVAILABLE(macos(10.13), ios(11.0)) _CUPS_PUBLIC
-#    define _CUPS_API_2_2_7 API_AVAILABLE(macos(10.14), ios(11.0)) _CUPS_PUBLIC
-#    define _CUPS_API_2_3 _CUPS_PUBLIC
+#    define _CUPS_API_2_2_4 API_AVAILABLE(macos(10.13), ios(12.0)) _CUPS_PUBLIC
+#    define _CUPS_API_2_2_7 API_AVAILABLE(macos(10.14), ios(13.0)) _CUPS_PUBLIC
+#    define _CUPS_API_2_3 API_AVAILABLE(macos(10.14), ios(13.0)) _CUPS_PUBLIC
 #  else
 #    define _CUPS_API_1_1_19 _CUPS_PUBLIC
 #    define _CUPS_API_1_1_20 _CUPS_PUBLIC
index fea9e5af5e57ee65f545f820d82080cd61ec4e97..1a8c388239e3880c5a3e55967aae93b522e90912 100644 (file)
Binary files a/doc/help/cupspm.epub and b/doc/help/cupspm.epub differ
index c27281518c08690e47583fbedb6b05a1c979f2e6..fa1a87681e959bb6a3acb159d2bfdca15717187a 100644 (file)
@@ -187,7 +187,6 @@ h2.title, h3.title {
           <li><a href="#authentication">Authentication</a></li>
         </ul></li>
         <li><a href="#FUNCTIONS">Functions</a><ul class="subcontents">
-          <li><a href="#CF_OPTIONS">CF_OPTIONS</a></li>
           <li><a href="#cupsAddDest">cupsAddDest</a></li>
           <li><a href="#cupsAddDestMediaOptions">cupsAddDestMediaOptions</a></li>
           <li><a href="#cupsAddIntegerOption">cupsAddIntegerOption</a></li>
@@ -477,9 +476,6 @@ h2.title, h3.title {
           <li><a href="#cups_option_s">cups_option_s</a></li>
           <li><a href="#cups_size_s">cups_size_s</a></li>
         </ul></li>
-        <li><a href="#VARIABLES">Variables</a><ul class="subcontents">
-          <li><a href="#kSecOidOrganizationalUnit">kSecOidOrganizationalUnit</a></li>
-        </ul></li>
         <li><a href="#ENUMERATIONS">Enumerations</a><ul class="subcontents">
           <li><a href="#cups_ptype_e">cups_ptype_e</a></li>
           <li><a href="#http_encoding_e">http_encoding_e</a></li>
@@ -1215,19 +1211,6 @@ cups_password_cb2(const char *prompt, http_t *http,
     <p>The <code>resource</code> argument specifies the path used for the request.</p>
     <p>The <code>user_data</code> argument provides the user data pointer from the <code>cupsSetPasswordCB2</code> call.</p>
       <h2 class="title"><a id="FUNCTIONS">Functions</a></h2>
-<h3 class="function"><a id="CF_OPTIONS">CF_OPTIONS</a></h3>
-        <p class="description"></p>
-<p class="code">
-typedef CF_OPTIONS(uint32_t, SecKeyUsage);</p>
-<h4 class="parameters">Parameters</h4>
-<table class="list"><tbody>
-<tr><th>uint32_t</th>
-</tr>
-<tr><th>SecKeyUsage</th>
-</tr>
-</tbody></table>
-<h4 class="returnvalue">Return Value</h4>
-        <p class="description"></p>
 <h3 class="function"><a id="cupsAddDest">cupsAddDest</a></h3>
         <p class="description">Add a destination to the list of destinations.</p>
 <p class="code">
@@ -1256,7 +1239,7 @@ a copy of that destination's options.<br>
 <br>
 Use the <a href="#cupsSaveDests"><code>cupsSaveDests</code></a> function to save the updated list of
 destinations to the user's lpoptions file.</p>
-<h3 class="function"><span class="info">&#160;CUPS 2.3&#160;</span><a id="cupsAddDestMediaOptions">cupsAddDestMediaOptions</a></h3>
+<h3 class="function"><span class="info">&#160;CUPS 2.3/macOS 10.14&#160;</span><a id="cupsAddDestMediaOptions">cupsAddDestMediaOptions</a></h3>
         <p class="description">Add the option corresponding to the specified media size.</p>
 <p class="code">
 int cupsAddDestMediaOptions(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, unsigned flags, <a href="#cups_size_t">cups_size_t</a> *size, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p>
@@ -1567,7 +1550,7 @@ int cupsDoAuthentication(<a href="#http_t">http_t</a> *http, const char *method,
 status, prior to resubmitting your request.
 
 </p>
-<h3 class="function"><span class="info">&#160;CUPS 2.3&#160;</span><a id="cupsEncodeOption">cupsEncodeOption</a></h3>
+<h3 class="function"><span class="info">&#160;CUPS 2.3/macOS 10.14&#160;</span><a id="cupsEncodeOption">cupsEncodeOption</a></h3>
         <p class="description">Encode a single option into an IPP attribute.</p>
 <p class="code">
 <a href="#ipp_attribute_t">ipp_attribute_t</a> *cupsEncodeOption(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group_tag, const char *name, const char *value);</p>
@@ -6127,10 +6110,6 @@ typedef struct _ipp_s ipp_t;
         <td class="description">Top margin in hundredths of
 millimeters</td></tr>
 </tbody></table>
-      <h2 class="title"><a id="VARIABLES">Variables</a></h2>
-      <h3 class="variable"><a id="kSecOidOrganizationalUnit">kSecOidOrganizationalUnit</a></h3>
-        <p class="description">Constants, very secure stuff...</p>
-      <p class="code">extern const void *kSecOidOrganizationalUnit;</p>
       <h2 class="title"><a id="ENUMERATIONS">Constants</a></h2>
       <h3 class="enumeration"><a id="cups_ptype_e">cups_ptype_e</a></h3>
         <p class="description">Printer type/capability bit