Bug 265568 - devel/libsoup: Adding a docs option
Summary: devel/libsoup: Adding a docs option
Status: Closed FIXED
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: freebsd-desktop (Team)
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-08-02 05:56 UTC by Sean Champ
Modified: 2022-08-16 21:44 UTC (History)
1 user (show)

See Also:
bugzilla: maintainer-feedback? (desktop)


Attachments
patch for adding docs option (devel/libsoup) (1.71 KB, patch)
2022-08-02 05:56 UTC, Sean Champ
no flags Details | Diff
linted patch for adding docs option (devel/libsoup) (1.60 KB, patch)
2022-08-02 05:59 UTC, Sean Champ
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Sean Champ 2022-08-02 05:56:11 UTC
Created attachment 235629 [details]
patch for adding docs option (devel/libsoup)

This diff is based on the changeset 3d5ef8caecd9 in git @ FreeBSD ports
circa 2022-05-19 19:10:50 +0200 for devel/libsoup version 2.74.2

Options added:

- DOCS: Build and install the libsoup Reference Manual

  The manual will be installed to a directory for libsoup within
  ${PREFIX}/share/gtk-doc

  gtk-doc files installed to the gtk-doc dir will automatically be added
  to the plist with add-plist-docs

  Under the DOCS option, the project's NEWS file will be installed to
  DOCSCDIR. This file is added to pkg-plist
Comment 1 Sean Champ 2022-08-02 05:57:24 UTC
Comment on attachment 235629 [details]
patch for adding docs option (devel/libsoup)

oops added an additional whitespace line. I'll try to consult oops about this, in the morning. Health, all
Comment 2 Sean Champ 2022-08-02 05:59:54 UTC
Created attachment 235630 [details]
linted patch for adding docs option (devel/libsoup)

trimmed the added whitespace line from the patch
Comment 3 commit-hook freebsd_committer freebsd_triage 2022-08-16 21:07:20 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/ports/commit/?id=1edbd06c6facd29a14635928395323aa3d6ae4a1

commit 1edbd06c6facd29a14635928395323aa3d6ae4a1
Author:     Adriaan de Groot <adridg@FreeBSD.org>
AuthorDate: 2022-08-16 21:04:24 +0000
Commit:     Adriaan de Groot <adridg@FreeBSD.org>
CommitDate: 2022-08-16 21:06:30 +0000

    devel/libsoup: add a DOCS option

    Add DOCS, which just uses gtk_doc to do the work. The change
    was suggested by Sean Champ in the linked PR, but I reworked
    it substantially to be explicit about the files, and to use
    the simplest tooling. Other changes suggested by the way
    devel/libical and devel/json/glib do DOCS with gtk_doc.

    PR:             265568
    Reported by:    Sean Champ

 devel/libsoup/Makefile  | 14 +++++++++--
 devel/libsoup/pkg-plist | 65 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 77 insertions(+), 2 deletions(-)