gcc/doc/gccint/plugins/giving-information-about-a-plugin.rst

   1 ..
   2   Copyright 1988-2022 Free Software Foundation, Inc.
   3   This is part of the GCC manual.
   4   For copying conditions, see the copyright.rst file.
   5
   6 .. _plugins-description:
   7
   8 Giving information about a plugin
   9 *********************************
  10
  11 A plugin should give some information to the user about itself. This
  12 uses the following structure:
  13
  14 .. code-block:: c++
  15
  16   struct plugin_info
  17   {
  18     const char *version;
  19     const char *help;
  20   };
  21
  22 Such a structure is passed as the ``user_data`` by the plugin's
  23 init routine using ``register_callback`` with the
  24 ``PLUGIN_INFO`` pseudo-event and a null callback.