farsight2-gtk-doc.patch

   1 --- farsight2-0.0.31/gst-libs/gst/farsight/fs-conference-iface.c.orig   2011-10-09 23:06:33.000000000 +0200
   2 +++ farsight2-0.0.31/gst-libs/gst/farsight/fs-conference-iface.c        2021-03-08 18:39:40.693431414 +0100
   3 @@ -43,7 +43,7 @@
   4   *
   5   * This will communicate asynchronous events to the user through #GstMessage
   6   * of type #GST_MESSAGE_ELEMENT sent over the #GstBus.
   7 - * </para>
   8 + *
   9   * <refsect2><title>The "<literal>farsight-error</literal>" message</title>
  10   * |[
  11   * "src-object"       #GObject           The object (#FsConference, #FsSession or #FsStream) that emitted the error
  12 @@ -55,7 +55,7 @@
  13   * The message is sent on asynchronous errors.
  14   * </para>
  15   * </refsect2>
  16 - * <para>
  17 + *
  18   */
  19
  20  static void fs_conference_iface_init (FsConferenceClass *iface);
  21 --- farsight2-0.0.31/gst-libs/gst/farsight/fs-session.c.orig    2011-10-09 23:06:33.000000000 +0200
  22 +++ farsight2-0.0.31/gst-libs/gst/farsight/fs-session.c 2021-03-08 18:40:29.326501279 +0100
  23 @@ -39,7 +39,7 @@
  24   *
  25   * This will communicate asynchronous events to the user through #GstMessage
  26   * of type #GST_MESSAGE_ELEMENT sent over the #GstBus.
  27 - * </para>
  28 + *
  29   * <refsect2><title>The "<literal>farsight-send-codec-changed</literal>"
  30   *   message</title>
  31   * |[
  32 @@ -68,7 +68,7 @@
  33   * next "farsight-codecs-changed" message until reading the codecs.
  34   * </para>
  35   * </refsect2>
  36 - * <para>
  37 + *
  38   */
  39
  40  #ifdef HAVE_CONFIG_H
  41 --- farsight2-0.0.31/gst-libs/gst/farsight/fs-stream.c.orig     2011-10-09 23:06:33.000000000 +0200
  42 +++ farsight2-0.0.31/gst-libs/gst/farsight/fs-stream.c  2021-03-08 18:41:26.726190318 +0100
  43 @@ -36,7 +36,7 @@
  44   *
  45   * This will communicate asynchronous events to the user through #GstMessage
  46   * of type #GST_MESSAGE_ELEMENT sent over the #GstBus.
  47 - * </para>
  48 + *
  49   * <refsect2><title>The "<literal>farsight-new-local-candidate</literal>" message</title>
  50   * |[
  51   * "stream"           #FsStream          The stream that emits the message
  52 @@ -93,7 +93,7 @@
  53   * This message is emitted the state of a component of a stream changes.
  54   * </para>
  55   * </refsect2>
  56 - * <para>
  57 + *
  58   */
  59
  60  #ifdef HAVE_CONFIG_H
  61 --- farsight2-0.0.31/gst/fsrtpconference/fs-rtp-session.c.orig  2021-03-08 22:31:45.561327262 +0100
  62 +++ farsight2-0.0.31/gst/fsrtpconference/fs-rtp-session.c       2021-03-08 22:31:55.317941073 +0100
  63 @@ -30,7 +30,7 @@
  64   * fs_conference_new_session() on a #FsRtpConference. It can be either
  65   * Audio or Video. It also represents data send with one and only one
  66   * SSRC (although if there is a SSRC collision, that SSRC may change).
  67 - * </para>
  68 + *
  69   * <refsect2><title>Codec profiles</title>
  70   * <para>
  71   * It is possible to define "codec profiles", that is non-autodetected
  72 @@ -50,7 +50,7 @@
  73   * Also, it is possible to declare profiles with only a decoding pipeline,
  74   * you will only be able to receive from this codec, the encoding may be a
  75   * secondary pad of some other codec.
  76 - * </para></refsect2><para>
  77 + * </para></refsect2>
  78   */
  79
  80  #ifdef HAVE_CONFIG_H
  81 --- farsight2-0.0.31/common/gstdoc-scangobj.orig        2010-10-08 18:38:56.000000000 +0200
  82 +++ farsight2-0.0.31/common/gstdoc-scangobj     2021-03-08 21:29:32.704883215 +0100
  83 @@ -30,9 +30,6 @@
  84
  85  use Getopt::Long;
  86
  87 -unshift @INC, '/usr/share/gtk-doc/data';
  88 -require "gtkdoc-common.pl";
  89 -
  90  # Options
  91
  92  # name of documentation module
  93 @@ -1791,6 +1788,59 @@
  94    unlink "./$MODULE-scan.c", "./$MODULE-scan.o", "./$MODULE-scan.lo", "./$MODULE-scan";
  95  }
  96
  97 +# Copied from gtk-doc 1db161bd708cdfb88b362ea0b5d047034d9c3272
  98 +#############################################################################
  99 +# Function    : UpdateFileIfChanged
 100 +# Description : Compares the old version of the file with the new version and
 101 +#                if the file has changed it moves the new version into the old
 102 +#                versions place. This is used so we only change files if
 103 +#                needed, so we can do proper dependency tracking and we don't
 104 +#                needlessly check files into version control systems that haven't
 105 +#               changed.
 106 +#                It returns 0 if the file hasn't changed, and 1 if it has.
 107 +# Arguments   : $old_file - the pathname of the old file.
 108 +#                $new_file - the pathname of the new version of the file.
 109 +#                $make_backup - 1 if a backup of the old file should be kept.
 110 +#                        It will have the .bak suffix added to the file name.
 111 +#############################################################################
 112 +
 113 +sub UpdateFileIfChanged {
 114 +    my ($old_file, $new_file, $make_backup) = @_;
 115 +
 116 +    #@TRACE@("Comparing $old_file with $new_file...");
 117 +
 118 +    # If the old file doesn't exist we want this to default to 1.
 119 +    my $exit_code = 1;
 120 +
 121 +    if (-e $old_file) {
 122 +        `cmp -s "$old_file" "$new_file"`;
 123 +        $exit_code = $? >> 8;
 124 +        #@TRACE@("   cmp exit code: $exit_code ($?)");
 125 +    }
 126 +
 127 +    if ($exit_code > 1) {
 128 +        die "Error running 'cmp $old_file $new_file'";
 129 +    }
 130 +
 131 +    if ($exit_code == 1) {
 132 +        #@TRACE@("   files changed - replacing old version with new version.");
 133 +        if ($make_backup && -e $old_file) {
 134 +            rename ($old_file, "$old_file.bak")
 135 +                || die "Can't move $old_file to $old_file.bak: $!";
 136 +        }
 137 +        rename ($new_file, $old_file)
 138 +            || die "Can't move $new_file to $old_file: $!";
 139 +
 140 +        return 1;
 141 +    } else {
 142 +        #@TRACE@("   files the same - deleting new version.");
 143 +        unlink ("$new_file")
 144 +            || die "Can't delete file: $new_file: $!";
 145 +
 146 +        return 0;
 147 +    }
 148 +}
 149 +
 150  #&UpdateFileIfChanged ($old_signals_filename, $new_signals_filename, 0);
 151  &UpdateFileIfChanged ($old_hierarchy_filename, $new_hierarchy_filename, 0);
 152  &UpdateFileIfChanged ($old_interfaces_filename, $new_interfaces_filename, 0);
 153 --- farsight2-0.0.31/docs/plugins/gtkdoc-scangobj-transmitters.orig     2010-11-01 22:32:09.000000000 +0100
 154 +++ farsight2-0.0.31/docs/plugins/gtkdoc-scangobj-transmitters  2021-03-08 21:33:25.266956651 +0100
 155 @@ -30,9 +30,6 @@
 156
 157  use Getopt::Long;
 158
 159 -unshift @INC, '/usr/share/gtk-doc/data';
 160 -require "gtkdoc-common.pl";
 161 -
 162  # Options
 163
 164  # name of documentation module
 165 @@ -842,7 +839,7 @@
 166
 167    for (i = 0; i < level; i++)
 168      fprintf (fp, "  ");
 169 -  fprintf (fp, g_type_name (type));
 170 +  fprintf (fp, "%s", g_type_name (type));
 171    fprintf (fp, "\\n");
 172
 173    children = g_type_children (type, &n_children);
 174 @@ -893,7 +890,7 @@
 175
 176    if (n_interfaces > 0)
 177      {
 178 -      fprintf (fp, g_type_name (type));
 179 +      fprintf (fp, "%s", g_type_name (type));
 180        for (i=0; i < n_interfaces; i++)
 181            fprintf (fp, " %s", g_type_name (interfaces[i]));
 182        fprintf (fp, "\\n");
 183 @@ -938,7 +935,7 @@
 184
 185    if (n_prerequisites > 0)
 186      {
 187 -      fprintf (fp, g_type_name (type));
 188 +      fprintf (fp, "%s", g_type_name (type));
 189        for (i=0; i < n_prerequisites; i++)
 190            fprintf (fp, " %s", g_type_name (prerequisites[i]));
 191        fprintf (fp, "\\n");
 192 @@ -1558,6 +1555,59 @@
 193
 194  unlink "./$MODULE-scan.c", "./$MODULE-scan.o", "./$MODULE-scan.lo", "./$MODULE-scan";
 195
 196 +# Copied from gtk-doc 1db161bd708cdfb88b362ea0b5d047034d9c3272
 197 +#############################################################################
 198 +# Function    : UpdateFileIfChanged
 199 +# Description : Compares the old version of the file with the new version and
 200 +#                if the file has changed it moves the new version into the old
 201 +#                versions place. This is used so we only change files if
 202 +#                needed, so we can do proper dependency tracking and we don't
 203 +#                needlessly check files into version control systems that haven't
 204 +#               changed.
 205 +#                It returns 0 if the file hasn't changed, and 1 if it has.
 206 +# Arguments   : $old_file - the pathname of the old file.
 207 +#                $new_file - the pathname of the new version of the file.
 208 +#                $make_backup - 1 if a backup of the old file should be kept.
 209 +#                        It will have the .bak suffix added to the file name.
 210 +#############################################################################
 211 +
 212 +sub UpdateFileIfChanged {
 213 +    my ($old_file, $new_file, $make_backup) = @_;
 214 +
 215 +    #@TRACE@("Comparing $old_file with $new_file...");
 216 +
 217 +    # If the old file doesn't exist we want this to default to 1.
 218 +    my $exit_code = 1;
 219 +
 220 +    if (-e $old_file) {
 221 +        `cmp -s "$old_file" "$new_file"`;
 222 +        $exit_code = $? >> 8;
 223 +        #@TRACE@("   cmp exit code: $exit_code ($?)");
 224 +    }
 225 +
 226 +    if ($exit_code > 1) {
 227 +        die "Error running 'cmp $old_file $new_file'";
 228 +    }
 229 +
 230 +    if ($exit_code == 1) {
 231 +        #@TRACE@("   files changed - replacing old version with new version.");
 232 +        if ($make_backup && -e $old_file) {
 233 +            rename ($old_file, "$old_file.bak")
 234 +                || die "Can't move $old_file to $old_file.bak: $!";
 235 +        }
 236 +        rename ($new_file, $old_file)
 237 +            || die "Can't move $new_file to $old_file: $!";
 238 +
 239 +        return 1;
 240 +    } else {
 241 +        #@TRACE@("   files the same - deleting new version.");
 242 +        unlink ("$new_file")
 243 +            || die "Can't delete file: $new_file: $!";
 244 +
 245 +        return 0;
 246 +    }
 247 +}
 248 +
 249  #&UpdateFileIfChanged ($old_signals_filename, $new_signals_filename, 0);
 250  &UpdateFileIfChanged ($old_hierarchy_filename, $new_hierarchy_filename, 0);
 251  &UpdateFileIfChanged ($old_interfaces_filename, $new_interfaces_filename, 0);
 252 --- farsight2-0.0.31/common-modified/gtk-doc-plugins.mak.orig   2011-09-07 22:20:18.000000000 +0200
 253 +++ farsight2-0.0.31/common-modified/gtk-doc-plugins.mak        2021-03-08 22:25:41.416633337 +0100
 254 @@ -156,23 +156,13 @@ scan-build.stamp: $(HFILE_GLOB) $(EXTRA_
 255             --ignore-headers="$(IGNORE_HFILES)";                        \
 256         touch scan-build.stamp
 257
 258 -#### update templates; done on every build ####
 259 +#### generate templates; done on every build ####
 260
 261 -### FIXME: make this error out again when docs are fixed for 0.9
 262 -# in a non-srcdir build, we need to copy files from the previous step
 263 -# and the files from previous runs of this step
 264 -tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
 265 -       @echo '*** Rebuilding template files ***'
 266 -       if test x"$(srcdir)" != x. ; then                               \
 267 -           for f in $(SCANOBJ_FILES) $(SCAN_FILES);                    \
 268 -           do                                                          \
 269 -               if test -e $(srcdir)/$$f; then cp $(srcdir)/$$f . ; fi; \
 270 -           done;                                                       \
 271 -       fi
 272 -       gtkdoc-mktmpl --module=$(DOC_MODULE) | tee tmpl-build.log
 273 +tmpl-build.stamp:
 274 +       @echo '  DOC   Building template files'
 275         $(PYTHON) \
 276                 $(top_srcdir)/common/mangle-tmpl.py $(srcdir)/inspect tmpl
 277 -       @cat $(DOC_MODULE)-unused.txt
 278 +       @-cat $(DOC_MODULE)-unused.txt
 279         rm -f tmpl-build.log
 280         touch tmpl-build.stamp
 281
 282 @@ -190,9 +180,13 @@ sgml-build.stamp: tmpl.stamp scan-build.
 283                 $(top_srcdir)/common/plugins.xsl $$a > xml/`basename $$a`; done
 284         @for f in $(EXAMPLE_CFILES); do \
 285                 $(PYTHON) $(top_srcdir)/common/c-to-xml.py $$f > xml/element-`basename $$f .c`.xml; done
 286 +       @_source_dir='' ;                                               \
 287 +       for i in $(DOC_SOURCE_DIR) ; do                                 \
 288 +           _source_dir="$${_source_dir} --source-dir=$$i" ;            \
 289 +       done ;                                                          \
 290         gtkdoc-mkdb \
 291                 --module=$(DOC_MODULE) \
 292 -               --source-dir=$(DOC_SOURCE_DIR) \
 293 +               $${_source_dir} \
 294                  --expand-content-files="$(expand_content_files)" \
 295                 --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) \
 296                 --output-format=xml \
 297 @@ -217,10 +211,7 @@ html-build.stamp: sgml.stamp $(DOC_MAIN_
 298         @for f in $(content_files); do cp $(srcdir)/$$f html; done
 299         cp -pr xml html
 300         cp ../version.entities html
 301 -       cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE)
 302 -       mv html/index.sgml html/index.sgml.bak
 303 -       $(SED) "s/ href=\"$(DOC_MODULE)\// href=\"$(DOC_MODULE)-@GST_MAJORMINOR@\//g" html/index.sgml.bak >html/index.sgml
 304 -       rm -f html/index.sgml.bak
 305 +       cd html && gtkdoc-mkhtml $(DOC_MODULE)-@GST_MAJORMINOR@ $(DOC_MAIN_SGML_FILE)
 306         rm -f html/$(DOC_MAIN_SGML_FILE)
 307         rm -rf html/xml
 308         rm -f html/version.entities
 309 @@ -269,11 +260,11 @@ install-data-local:
 310               $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
 311             done; \
 312           fi; \
 313 -         echo '-- Installing $(srcdir)/html/$(DOC_MODULE).devhelp' ; \
 314 -         $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp \
 315 +         echo '-- Installing $(srcdir)/html/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp' ; \
 316 +         $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp \
 317             $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
 318 -         if test -e $(srcdir)/html/$(DOC_MODULE).devhelp2; then \
 319 -                   $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp2 \
 320 +         if test -e $(srcdir)/html/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; then \
 321 +                   $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2 \
 322                     $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; \
 323           fi; \
 324           (which gtkdoc-rebase >/dev/null && \