summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNiels De Graef <nielsdegraef@gmail.com>2022-08-07 23:00:18 +0200
committerNiels De Graef <nielsdegraef@gmail.com>2022-09-04 12:50:58 +0000
commit3f36be1fd09e90d7b472cee24f5b4cb9eb12b76b (patch)
tree4b6d6572cc918b96c5481d4951daa00b4b4783cb /docs
parent4ec1071ea3070bdc85fd1c1cfe61af2349a8b39c (diff)
downloadgcr-3f36be1fd09e90d7b472cee24f5b4cb9eb12b76b.tar.gz
Drop gcr-gtk3 and gcr-gtk4
gcr historically consisted of 2 high-level parts: `gcr-base` and `gcr-ui`. `gcr-base` contains the core classes and interfaces to deal with crypto-related items (e.g. `GcrCertificate`), while `gcr-ui` contained GTK widgets to show those items (e.g. `GcrCertificateWidget`). Now: with the move to gcr4, it's becoming more and more clear to that this isn't really a path forward: On one hand, GTK4 has transitioned from a platform toolkit (usually GNOME was the primary target) to one that allows you to build your platform on top (e.g. libadwaita, libgranite, or your very own). Kepeing that in mind, having "GTK-based" widgets for use in general purpose doesn't really make sense, since it will always look out touch on platforms On the other hand, widgets are usually more faster-moving targets in both looks as well as API than an actual library, so in practice gcr-ui has a different lifecycle than gcr-base. Finally, @tintou has been doing an awesome effort to implement an API that allows consumers to write their own widgets, without having to deal with asn1 decoding etc. At this point, I think the certificate widget is likely the only widget we're seeing interest in. As such, this commit drops gcr-gtk3 and gcr-gtk4 as libraries. There's still a gcr-viewer debugging tool as a troubleshooting/debugging tool, that's it. See https://gitlab.gnome.org/GNOME/gcr/-/issues/100 for the related discussion.
Diffstat (limited to 'docs')
-rw-r--r--docs/gcr-gtk3/gcr-gtk3.toml.in59
-rw-r--r--docs/gcr-gtk3/images/certificate-widget.pngbin16144 -> 0 bytes
-rw-r--r--docs/gcr-gtk3/images/combo-selector.pngbin7065 -> 0 bytes
-rw-r--r--docs/gcr-gtk3/images/import-button.pngbin2925 -> 0 bytes
-rw-r--r--docs/gcr-gtk3/images/key-widget.pngbin10159 -> 0 bytes
-rw-r--r--docs/gcr-gtk3/images/list-selector.pngbin10123 -> 0 bytes
-rw-r--r--docs/gcr-gtk3/images/tree-selector.pngbin10628 -> 0 bytes
-rw-r--r--docs/gcr-gtk3/images/viewer-widget.pngbin13167 -> 0 bytes
-rw-r--r--docs/gcr-gtk3/meson.build35
-rw-r--r--docs/gcr-gtk3/urlmap.js6
-rw-r--r--docs/gcr-gtk3/widget-gallery.md20
-rw-r--r--docs/gcr-gtk4/gcr-gtk4.toml.in45
-rw-r--r--docs/gcr-gtk4/meson.build31
-rw-r--r--docs/gcr-gtk4/urlmap.js6
-rw-r--r--docs/meson.build10
15 files changed, 0 insertions, 212 deletions
diff --git a/docs/gcr-gtk3/gcr-gtk3.toml.in b/docs/gcr-gtk3/gcr-gtk3.toml.in
deleted file mode 100644
index 0c17d69..0000000
--- a/docs/gcr-gtk3/gcr-gtk3.toml.in
+++ /dev/null
@@ -1,59 +0,0 @@
-[library]
-namespace = "GcrUi"
-version = "@GCR_VERSION@"
-browse_url = "https://gitlab.gnome.org/GNOME/gcr/"
-repository_url = "https://gitlab.gnome.org/GNOME/gcr.git"
-authors = "GCR contributors"
-license = "LGPL-2.0-or-later"
-description = "Library providing GTK widgets for high level crypto"
-dependencies = [ "GObject-2.0", "Gio-2.0", "Gtk-3.0", "Gck-@GCK_VERSION@", "Gcr-@GCR_VERSION@" ]
-devhelp = true
-search_index = true
-
- [dependencies."GObject-2.0"]
- name = "GObject"
- description = "The base type system library"
- docs_url = "https://developer.gnome.org/gobject/stable"
-
- [dependencies."Gio-2.0"]
- name = "Gio"
- description = "GObject interfaces and objects"
- docs_url = "https://developer.gnome.org/gio/stable"
-
- [dependencies."Gtk-3.0"]
- name = "Gtk"
- description = "The GTK UI toolkit"
- docs_url = "https://docs.gtk.org/gtk4/"
-
- [dependencies."Gck-@GCK_VERSION@"]
- name = "Gck"
- description = "GObject bindings for PKCS#11"
- docs_url = "https://gnome.pages.gitlab.gnome.org/gcr/gck-@GCK_VERSION@"
-
- [dependencies."Gcr-@GCR_VERSION@"]
- name = "Gcr"
- description = "GObject library for high level crypto parsing"
- docs_url = "https://gnome.pages.gitlab.gnome.org/gcr/gcr-@GCR_VERSION@"
-
-[theme]
-name = "basic"
-show_index_summary = true
-show_class_hierarchy = true
-
-[source-location]
-base_url = "https://gitlab.gnome.org/GNOME/gcr/-/blob/master/"
-
-[extra]
-content_files = [
- 'widget-gallery.md',
-]
-content_images = [
- 'images/certificate-widget.png',
- 'images/combo-selector.png',
- 'images/import-button.png',
- 'images/key-widget.png',
- 'images/list-selector.png',
- 'images/tree-selector.png',
- 'images/viewer-widget.png',
-]
-urlmap_file = "urlmap.js"
diff --git a/docs/gcr-gtk3/images/certificate-widget.png b/docs/gcr-gtk3/images/certificate-widget.png
deleted file mode 100644
index e3c9158..0000000
--- a/docs/gcr-gtk3/images/certificate-widget.png
+++ /dev/null
Binary files differ
diff --git a/docs/gcr-gtk3/images/combo-selector.png b/docs/gcr-gtk3/images/combo-selector.png
deleted file mode 100644
index 073f483..0000000
--- a/docs/gcr-gtk3/images/combo-selector.png
+++ /dev/null
Binary files differ
diff --git a/docs/gcr-gtk3/images/import-button.png b/docs/gcr-gtk3/images/import-button.png
deleted file mode 100644
index 9166bb8..0000000
--- a/docs/gcr-gtk3/images/import-button.png
+++ /dev/null
Binary files differ
diff --git a/docs/gcr-gtk3/images/key-widget.png b/docs/gcr-gtk3/images/key-widget.png
deleted file mode 100644
index db3a371..0000000
--- a/docs/gcr-gtk3/images/key-widget.png
+++ /dev/null
Binary files differ
diff --git a/docs/gcr-gtk3/images/list-selector.png b/docs/gcr-gtk3/images/list-selector.png
deleted file mode 100644
index 7f9c688..0000000
--- a/docs/gcr-gtk3/images/list-selector.png
+++ /dev/null
Binary files differ
diff --git a/docs/gcr-gtk3/images/tree-selector.png b/docs/gcr-gtk3/images/tree-selector.png
deleted file mode 100644
index 7bcd1a1..0000000
--- a/docs/gcr-gtk3/images/tree-selector.png
+++ /dev/null
Binary files differ
diff --git a/docs/gcr-gtk3/images/viewer-widget.png b/docs/gcr-gtk3/images/viewer-widget.png
deleted file mode 100644
index 1933e04..0000000
--- a/docs/gcr-gtk3/images/viewer-widget.png
+++ /dev/null
Binary files differ
diff --git a/docs/gcr-gtk3/meson.build b/docs/gcr-gtk3/meson.build
deleted file mode 100644
index fdb818b..0000000
--- a/docs/gcr-gtk3/meson.build
+++ /dev/null
@@ -1,35 +0,0 @@
-gcr_gtk3_content_files = [
- 'widget-gallery.md',
-]
-
-gcr_gtk3_toml = configure_file(
- input: 'gcr-gtk3.toml.in',
- output: '@BASENAME@',
- configuration: {
- 'GCR_VERSION': gcr_api_version,
- 'GCK_VERSION': gck_api_version,
- },
-)
-
-gcr_gtk3_docs = custom_target('gcr-gtk3-docs',
- input: gcr_gtk3_gir[0],
- output: gcr_gtk3_basename,
- command: [
- gi_docgen,
- 'generate',
- '--quiet',
- '--fatal-warnings',
- '--add-include-path=@0@'.format(build_root / 'gck'),
- '--add-include-path=@0@'.format(build_root / 'gcr'),
- '--config', gcr_gtk3_toml,
- '--output-dir=@OUTPUT@',
- '--no-namespace-dir',
- '--content-dir=@0@'.format(meson.current_source_dir()),
- '@INPUT@',
- ],
- depend_files: [ gcr_gtk3_toml, gcr_gtk3_content_files ],
- depends: [ gck_gir[0], gcr_gir[0] ],
- build_by_default: true,
- install: true,
- install_dir: get_option('datadir') / 'doc',
-)
diff --git a/docs/gcr-gtk3/urlmap.js b/docs/gcr-gtk3/urlmap.js
deleted file mode 100644
index 6946c20..0000000
--- a/docs/gcr-gtk3/urlmap.js
+++ /dev/null
@@ -1,6 +0,0 @@
-// A map between namespaces and base URLs for their online documentation
-baseURLs = [
- [ 'GLib', 'https://docs.gtk.org/glib/' ],
- [ 'GObject', 'https://docs.gtk.org/gobject/' ],
- [ 'Gio', 'https://docs.gtk.org/gio/' ],
-]
diff --git a/docs/gcr-gtk3/widget-gallery.md b/docs/gcr-gtk3/widget-gallery.md
deleted file mode 100644
index 27e1e90..0000000
--- a/docs/gcr-gtk3/widget-gallery.md
+++ /dev/null
@@ -1,20 +0,0 @@
-Title: Widget gallery
-
-Widget gallery
-==============
-
-Selector widgets
-----------------
-[![combo-selector](combo-selector.png)](class.ComboSelector.html)
-[![list-selector](list-selector.png)](class.ListSelector.html)
-[![tree-selector](tree-selector.png)](class.TreeSelector.html)
-
-Display widgets
----------------
-[![certificate-widget](certificate-widget.png)](class.CertificateWidget.html)
-[![key-widget](key-widget.png)](class.KeyWidget.html)
-[![viewer-widget](viewer-widget.png)](class.ViewerWidget.html)
-
-Import widgets
---------------
-[![import-button](import-button.png)](class.ImportButton.html)
diff --git a/docs/gcr-gtk4/gcr-gtk4.toml.in b/docs/gcr-gtk4/gcr-gtk4.toml.in
deleted file mode 100644
index 927ee38..0000000
--- a/docs/gcr-gtk4/gcr-gtk4.toml.in
+++ /dev/null
@@ -1,45 +0,0 @@
-[library]
-namespace = "GcrGtk"
-version = "@GCR_VERSION@"
-browse_url = "https://gitlab.gnome.org/GNOME/gcr/"
-repository_url = "https://gitlab.gnome.org/GNOME/gcr.git"
-authors = "GCR contributors"
-license = "LGPL-2.0-or-later"
-description = "Library providing GTK widgets for high level crypto"
-dependencies = [ "GObject-2.0", "Gio-2.0", "Gtk-4.0", "Gck-@GCK_VERSION@", "Gcr-@GCR_VERSION@" ]
-devhelp = true
-search_index = true
-
- [dependencies."GObject-2.0"]
- name = "GObject"
- description = "The base type system library"
- docs_url = "https://developer.gnome.org/gobject/stable"
-
- [dependencies."Gio-2.0"]
- name = "Gio"
- description = "GObject interfaces and objects"
- docs_url = "https://developer.gnome.org/gio/stable"
-
- [dependencies."Gtk-4.0"]
- name = "Gtk"
- description = "The GTK UI toolkit"
- docs_url = "https://docs.gtk.org/gtk4/"
-
- [dependencies."Gck-@GCK_VERSION@"]
- name = "Gck"
- description = "GObject bindings for PKCS#11"
- docs_url = "https://gnome.pages.gitlab.gnome.org/gcr/gck-@GCK_VERSION@"
-
- [dependencies."Gcr-@GCR_VERSION@"]
- name = "Gcr"
- description = "GObject library for high level crypto parsing"
- docs_url = "https://gnome.pages.gitlab.gnome.org/gcr/gcr-@GCR_VERSION@"
-
-[theme]
-name = "basic"
-show_index_summary = true
-show_class_hierarchy = true
-
-[source-location]
-base_url = "https://gitlab.gnome.org/GNOME/gcr/-/blob/master/"
-urlmap_file = "urlmap.js"
diff --git a/docs/gcr-gtk4/meson.build b/docs/gcr-gtk4/meson.build
deleted file mode 100644
index d3f34eb..0000000
--- a/docs/gcr-gtk4/meson.build
+++ /dev/null
@@ -1,31 +0,0 @@
-gcr_gtk4_toml = configure_file(
- input: 'gcr-gtk4.toml.in',
- output: '@BASENAME@',
- configuration: {
- 'GCR_VERSION': gcr_api_version,
- 'GCK_VERSION': gck_api_version,
- },
-)
-
-gcr_gtk4_docs = custom_target('gcr-gtk4-docs',
- input: gcr_gtk4_gir[0],
- output: gcr_gtk4_basename,
- command: [
- gi_docgen,
- 'generate',
- '--quiet',
- '--fatal-warnings',
- '--add-include-path=@0@'.format(build_root / 'gck'),
- '--add-include-path=@0@'.format(build_root / 'gcr'),
- '--config', gcr_gtk4_toml,
- '--output-dir=@OUTPUT@',
- '--no-namespace-dir',
- '--content-dir=@0@'.format(meson.current_source_dir()),
- '@INPUT@',
- ],
- depend_files: [ gcr_gtk4_toml ],
- depends: [ gck_gir[0], gcr_gir[0] ],
- build_by_default: true,
- install: true,
- install_dir: get_option('datadir') / 'doc',
-)
diff --git a/docs/gcr-gtk4/urlmap.js b/docs/gcr-gtk4/urlmap.js
deleted file mode 100644
index 6946c20..0000000
--- a/docs/gcr-gtk4/urlmap.js
+++ /dev/null
@@ -1,6 +0,0 @@
-// A map between namespaces and base URLs for their online documentation
-baseURLs = [
- [ 'GLib', 'https://docs.gtk.org/glib/' ],
- [ 'GObject', 'https://docs.gtk.org/gobject/' ],
- [ 'Gio', 'https://docs.gtk.org/gio/' ],
-]
diff --git a/docs/meson.build b/docs/meson.build
index 3ae63b0..ddda3e8 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -2,19 +2,9 @@ gi_docgen = find_program('gi-docgen')
subdir('gck')
subdir('gcr')
-gtk_docs_targets = []
-if get_option('gtk3')
- subdir('gcr-gtk3')
- gtk_docs_targets += gcr_gtk3_docs
-endif
-if get_option('gtk4')
- subdir('gcr-gtk4')
- gtk_docs_targets += gcr_gtk4_docs
-endif
# Create a pseudo target that build all docs at once
alias_target('docs',
gck_docs,
gcr_docs,
- gtk_docs_targets,
)