Browse Source

Help: Reword AIX_SHARED_LIBRARY_ARCHIVE to avoid assuming a default

Brad King 1 year ago
parent
commit
7a05e8e994

+ 13 - 9
Help/prop_tgt/AIX_SHARED_LIBRARY_ARCHIVE.rst

@@ -3,20 +3,24 @@ AIX_SHARED_LIBRARY_ARCHIVE
 
 .. versionadded:: 3.31
 
-On AIX, enable creation of a shared library archive.  This places
-the shared object ``.so`` file inside an archive ``.a`` file.
+On AIX, enable or disable creation of a shared library archive
+for a ``SHARED`` library target:
 
-By default, CMake creates shared libraries on AIX as plain
-shared object ``.so`` files for consistency with other UNIX platforms.
-Alternatively, set this property to a true value to create a shared
-library archive instead, as is AIX convention.
+* If enabled, the shared object ``.so`` file is placed inside
+  an archive ``.a`` file.  This is the preferred convention on AIX.
 
-The shared object name in the archive encodes version information from
-the :prop_tgt:`SOVERSION` target property, if set, and otherwise from
-the :prop_tgt:`VERSION` target property, if set.
+  The shared object name in the archive encodes version information from
+  the :prop_tgt:`SOVERSION` target property, if set, and otherwise from
+  the :prop_tgt:`VERSION` target property, if set.
+
+* If disabled, a plain shared object ``.so`` file is produced.
+  This is consistent with other UNIX platforms.
 
 This property defaults to :variable:`CMAKE_AIX_SHARED_LIBRARY_ARCHIVE`
 if that variable is set when a non-imported ``SHARED`` library target
 is created by :command:`add_library`.  Imported targets must explicitly
 enable :prop_tgt:`!AIX_SHARED_LIBRARY_ARCHIVE` if they import an AIX
 shared library archive.
+
+For a non-imported target, if this property is not set, the
+default is *disabled*.

+ 1 - 1
Help/variable/CMAKE_AIX_SHARED_LIBRARY_ARCHIVE.rst

@@ -3,7 +3,7 @@ CMAKE_AIX_SHARED_LIBRARY_ARCHIVE
 
 .. versionadded:: 3.31
 
-On AIX, enable creation of shared library archives.
+On AIX, enable or disable creation of shared library archives.
 
 This variable initializes the :prop_tgt:`AIX_SHARED_LIBRARY_ARCHIVE`
 target property on non-imported ``SHARED`` library targets as they are