Changeset f56d2e7


Ignore:
Timestamp:
01/18/2023 02:32:27 PM (15 months ago)
Author:
Pierre Labastie <pierre.labastie@…>
Branches:
11.3, 12.0, 12.1, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, lazarus, lxqt, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, trunk, xry111/llvm18, xry111/xf86-video-removal
Children:
0f9a1f08
Parents:
e0fff61
Message:

change gi-docgen ulink to xref

Files:
17 edited

Legend:

Unmodified
Added
Removed
  • general/genlib/libgusb.xml

    re0fff61 rf56d2e7  
    8787    <bridgehead renderas="sect4">Optional</bridgehead>
    8888    <para role="optional">
    89       <ulink url="https://download.gnome.org/sources/gi-docgen/">gi-docgen</ulink>
     89      <xref linkend="gi-docgen"/>
    9090    </para>
    9191
     
    128128    <para>
    129129      <parameter>-Ddocs=false</parameter>: building documentation needs
    130       <application>gi-docgen</application>. Remove this switch if you have
     130      <xref linkend="gi-docgen"/>. Remove this switch if you have
    131131      installed <application>gi-docgen</application>, and you wish to build
    132132      the API documentation.
  • general/genlib/libportal.xml

    re0fff61 rf56d2e7  
    8383    <bridgehead renderas="sect4">Optional</bridgehead>
    8484    <para role="optional">
    85       <xref linkend="vala"/> and
    86       <ulink url="&gi-docgen-url;">gi-docgen</ulink>
     85      <xref linkend="gi-docgen"/> and
     86      <xref linkend="vala"/>
    8787    </para>
    8888
     
    138138    <para>
    139139      <parameter>-Ddocs=false</parameter>: Remove this parameter if
    140       <application>gi-docgen</application> is installed and you wish to rebuild
     140      <xref linkend="gi-docgen"/> is installed and you wish to rebuild
    141141      and install the API documentation.
    142142    </para>
  • general/graphlib/librsvg.xml

    re0fff61 rf56d2e7  
    8787    <para role="optional">
    8888      <xref linkend="docutils"/> (for man pages),
     89      <xref linkend="gi-docgen"/> (for documentation),
    8990      <xref linkend="xorg7-font"/> (for tests), and
    90       <ulink url="&gi-docgen-url;">gi-docgen</ulink> (for documentation)
    9191    </para>
    9292
     
    154154    </para>
    155155
    156     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    157       href="../../xincludes/gtk-doc-rebuild.xml"/>
     156    <para>
     157      <option>--disable-gtk-doc</option>: This switch prevents building
     158      the API documentation, even if <xref linkend="gi-docgen"/> (despite
     159      the name of the option) is available.
     160    </para>
    158161
    159162  </sect2>
  • gnome/applications/evince.xml

    re0fff61 rf56d2e7  
    102102      <xref linkend="gspell"/>,
    103103      <xref linkend="gst10-plugins-base"/>,
     104      <xref linkend="gi-docgen"/>,
    104105      <xref linkend="gtk-doc"/>,
    105106      <xref linkend="libgxps"/>,
     
    107108      <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>),
    108109      <ulink url="http://djvu.sourceforge.net/">DjVuLibre</ulink>,
    109       <ulink url="&gi-docgen-url;">gi-docgen</ulink>,
    110110      <ulink url="http://www.freedesktop.org/wiki/Software/libspectre/">libspectre</ulink>,
    111111      <ulink url="https://github.com/jlaurens/synctex">Synctex</ulink>, and
  • gnome/applications/file-roller.xml

    re0fff61 rf56d2e7  
    9999    <bridgehead renderas="sect4">Optional (for the API documentation)</bridgehead>
    100100    <para role="optional">
    101       <ulink url="&gi-docgen-url;">gi-docgen</ulink>
     101      <xref linkend="gi-docgen"/>
    102102    </para>
    103103
     
    160160    <para>
    161161      <option>-Dapi_docs=enabled</option>: Use this switch if you have
    162       <ulink url="&gi-docgen-url;">gi-docgen</ulink> installed and wish to
     162      <xref linkend="gi-docgen"/> installed and wish to
    163163      generate the API documentation.
    164164    </para>
  • gnome/platform/gcr.xml

    re0fff61 rf56d2e7  
    9090    <bridgehead renderas="sect4">Optional</bridgehead>
    9191    <para role="optional">
    92       <!--<xref linkend="gtk-doc"/> and-->
    93       <xref linkend="valgrind"/> and
    94       <ulink url="&gi-docgen-url;">gi-docgen</ulink>
     92      <xref linkend="gi-docgen"/> and
     93      <xref linkend="valgrind"/>
    9594    </para>
    9695
  • gnome/platform/gcr4.xml

    re0fff61 rf56d2e7  
    9090    <bridgehead renderas="sect4">Optional</bridgehead>
    9191    <para role="optional">
    92       <xref linkend="valgrind"/> and
    93       <ulink url="&gi-docgen-url;">gi-docgen</ulink>
     92      <xref linkend="gi-docgen"/> and
     93      <xref linkend="valgrind"/>
    9494    </para>
    9595
  • gnome/platform/libgweather.xml

    re0fff61 rf56d2e7  
    8989    <bridgehead renderas="sect4">Optional</bridgehead>
    9090    <para role="optional">
    91       <xref linkend="llvm"/> (for clang-format),
    92       <ulink url="&gi-docgen-url;">gi-docgen</ulink>,
    93       <ulink url="https://pypi.org/project/pylint/">pylint</ulink>, and
    94       for the bundled gi-docgen module:
    95       <phrase revision="sysv"><xref linkend="Jinja2"/>,
    96       <xref linkend="MarkupSafe"/>,</phrase>
    97       <xref linkend="pygments"/>,
    98       <ulink url="https://pypi.org/project/Markdown/">Markdown</ulink>,
    99       <ulink url="https://pypi.org/project/toml/">toml</ulink>, and
    100       <ulink url="https://pypi.org/project/typogrify/">typogrify</ulink>
     91      <xref linkend="gi-docgen"/> (gi-docgen is also provided as a meson
     92      subproject, which will be used if <option>-Dgtk_doc=false</option>
     93      is not passed to <command>meson</command>),
     94      <xref linkend="llvm"/> (for clang-format), and
     95      <ulink url="https://pypi.org/project/pylint/">pylint</ulink>
    10196    </para>
    10297
     
    147142      <parameter>-Dgtk_doc=false</parameter>: allows building without using
    148143      the bundled <application>gi-docgen</application> module. Remove this
    149       switch if you have the needed dependencies, and you wish to rebuild
    150       and install the API documentation.
     144      switch if you have installed <xref linkend="gi-docgen"/>, and wish to
     145      build and install the API documentation.
    151146    </para>
    152147
  • gnome/platform/libpeas.xml

    re0fff61 rf56d2e7  
    8484    <bridgehead renderas="sect4">Optional</bridgehead>
    8585    <para role="optional">
    86       <ulink url="&gi-docgen-url;">gi-docgen</ulink>,
     86      <xref linkend="gi-docgen"/>,
    8787      <ulink url="http://glade.gnome.org/">Glade</ulink>,
    8888      <ulink url="https://pypi.org/project/embed">embed</ulink>,
     
    149149      <option>-Dgtk_doc=true</option>: Add this switch if you wish to
    150150      build the reference manual and you have
    151       <ulink url="&gi-docgen-url;">gi-docgen</ulink> installed on your system.
     151      <xref linkend="gi-docgen"/> installed on your system.
    152152    </para>
    153153
  • gnome/platform/libshumate.xml

    re0fff61 rf56d2e7  
    7676    <bridgehead renderas="sect4">Optional</bridgehead>
    7777    <para role="optional">
    78       <xref linkend="gtk-doc"/> and
    79       <ulink url="&gi-docgen-url;">gi-docgen</ulink>
     78      <xref linkend="gi-docgen"/> and
     79      <xref linkend="gtk-doc"/>
    8080    </para>
    8181
     
    118118    <para>
    119119      <parameter>-Dgtk_doc=false</parameter>: This switch disables documentation
    120       generation because it requires
    121       <ulink url="&gi-docgen-url;">gi-docgen</ulink>. Remove this if you have
    122       gi-docgen installed and wish to generate the API documentation.
     120      generation. Remove this if you have both <xref linkend="gtk-doc"/> and
     121      <xref linkend="gi-docgen"/> installed and wish to generate the API
     122      documentation.
    123123    </para>
    124124  </sect2>
  • gnome/platform/nautilus.xml

    re0fff61 rf56d2e7  
    9696    <bridgehead renderas="sect4">Optional</bridgehead>
    9797    <para role="optional">
    98       <ulink url="&gi-docgen-url;">gi-docgen</ulink>
     98      <xref linkend="gi-docgen"/>
    9999    </para>
    100100
  • gnome/platform/rest.xml

    re0fff61 rf56d2e7  
    8585    <bridgehead renderas="sect4">Optional</bridgehead>
    8686    <para role="optional">
    87       <xref linkend="libadwaita1"/> (to build the demo),
    88       <xref linkend="vala"/>, and
    89       <ulink url="&gi-docgen-url;">gi-docgen</ulink>
     87      <xref linkend="gi-docgen"/>,
     88      <xref linkend="libadwaita1"/> (to build the demo), and
     89      <xref linkend="vala"/>
    9090    </para>
    9191
     
    132132    <para>
    133133      <parameter>-Dgtk_doc=false</parameter>: Remove this option if
    134       <ulink url="&gi-docgen-url;">gi-docgen</ulink>
     134      <xref linkend="gi-docgen"/>
    135135      is installed and you wish to build and install the API documentation.
    136136    </para>
  • networking/netlibs/libsoup3.xml

    re0fff61 rf56d2e7  
    9393      <xref linkend="brotli"/>,
    9494      <xref linkend="curl"/> (required to run the test suite),
    95       <xref linkend="sysprof"/> (for profiling),
     95      <xref linkend="gi-docgen"/>,
    9696      <xref linkend="mitkrb"/> (required to run the test suite),
    97       <!--<xref linkend="gtk-doc"/>,-->
    98          <!-- It seems that XMLRPC is part of PHP 5.4.10 -->
     97   <!-- It seems that XMLRPC is part of PHP 5.4.10 -->
    9998      <xref linkend="php"/> compiled with XMLRPC-EPI
    10099      support (only used for the XMLRPC regression tests),
    101100      <xref linkend="samba"/> (ntlm_auth is required to run the test suite), and
    102       <ulink url="&gi-docgen-url;">gi-docgen</ulink>
     101      <xref linkend="sysprof"/> (for profiling)
    103102    </para>
    104103
     
    158157      <option>-Ddocs=enabled</option>: Use this option if you want to build
    159158      the documentation. Note that you must have
    160       <ulink url="&gi-docgen-url;">gi-docgen</ulink> installed.
     159      <xref linkend="gi-docgen"/> installed.
    161160    </para>
    162161
  • x/lib/gdk-pixbuf.xml

    re0fff61 rf56d2e7  
    9898    <bridgehead renderas="sect4">Optional</bridgehead>
    9999    <para role="optional">
    100        <!--<xref linkend="jasper"/> and-->
    101   <!--<xref linkend="gtk-doc"/> and-->
    102       <ulink url="&gi-docgen-url;">gi-docgen</ulink>
     100      <xref linkend="gi-docgen"/>
    103101      (to generate documentation)
    104102    </para>
  • x/lib/gtk4.xml

    re0fff61 rf56d2e7  
    103103      <xref linkend="ffmpeg"/> (built with
    104104      <xref role='nodep' linkend='libvpx'/>),
     105      <xref linkend="gi-docgen"/>,
    105106      <xref linkend="gtk-doc"/>,
    106107      <xref role="runtime" linkend="highlight"/>
     
    109110      <xref linkend="libcloudproviders"/>,
    110111      <xref linkend="sassc"/>,
    111       <xref linkend="tracker3"/>,
    112       <ulink url="&gi-docgen-url;">gi-docgen</ulink>, and
    113       <!--<ulink url="https://gitlab.gnome.org/World/libcloudproviders">libcloudproviders</ulink>, and-->
     112      <xref linkend="tracker3"/>, and
    114113      <ulink url="https://vulkan.lunarg.com/sdk/home">vulkan</ulink>
    115114    </para>
     
    194193    <para>
    195194      <option>-Dgtk_doc=true</option>: Use this switch if you have
    196       <ulink url="&gi-docgen-url;">gi-docgen</ulink>
     195      <xref linkend="gi-docgen"/>
    197196      installed and wish to generate the API reference documentation.
    198197    </para>
  • x/lib/pango.xml

    re0fff61 rf56d2e7  
    9393  <!--<xref linkend="gtk-doc"/>,-->
    9494      <xref linkend="sysprof"/>,
    95       <ulink url="&gi-docgen-url;">gi-docgen</ulink>
    96       (to generate documentation),
     95      <xref linkend="gi-docgen"/> (to generate documentation),
    9796      <ulink url="https://ftpmirror.gnu.org/gnu/help2man">help2man</ulink>, and
    9897      <ulink url="https://linux.thai.net/projects/libthai">libthai</ulink>
     
    150149      href="../../xincludes/meson-buildtype-release.xml"/>
    151150
    152     <!-- gtk-doc replaced by gi-docgen
    153     <para>
    154       <option>-Dgtk_doc</option>: Use this switch if gtk-doc is
    155       installed and you wish to rebuild and install the API documentation.
    156     </para>-->
     151    <para>
     152      <option>-Dgtk_doc=true</option>: Although the default value of this
     153      option is <option>false</option>, the API documentation will be rebuilt
     154      and installed if <xref linkend="gi-docgen"/> is available, either
     155      as a meson submodule (see below the <option>--wrap-mod</option> option)
     156      or on the system. The only difference when setting this option to
     157      <option>true</option> is that meson exits with in error if gi-docgen
     158      is not available.
     159    </para>
    157160
    158161    <para>
  • x/lib/webkitgtk.xml

    re0fff61 rf56d2e7  
    116116    <para role="optional">
    117117      <xref linkend="bubblewrap"/>,
     118      <xref linkend="gi-docgen"/>,
    118119      <xref linkend="gtk4"/>,
    119120      <xref linkend="harfbuzz"/>,
     
    121122      <xref linkend="woff2"/>,
    122123      <ulink url="https://ccache.dev/">ccache</ulink>,
    123       <ulink url="&gi-docgen-url;">gi-docgen</ulink>,
    124124      <ulink url="https://sourceforge.net/projects/hunspell/files/Hyphen/">Hyphen</ulink>,
    125125      <ulink url="https://github.com/AOMediaCodec/libavif">libavif</ulink>,
     
    241241      <parameter>-DENABLE_DOCUMENTATION=OFF</parameter>: This switch disables
    242242      regenerating the documentation. Remove this switch if you have
    243       <ulink url="&gi-docgen-url;">gi-docgen</ulink>
     243      <xref linkend="gi-docgen"/>
    244244      installed and wish to regenerate the documentation.
    245245    </para>
Note: See TracChangeset for help on using the changeset viewer.