From 483eb2f56657e8e7f419ab1a4fab8dce9ade8609 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 27 Apr 2024 20:24:20 +0200 Subject: Adding upstream version 14.2.21. Signed-off-by: Daniel Baumann --- doc/api/index.rst | 45 +++++++++++++++++++++++++++++++++++++++++++++ doc/api/libcephfs-java.rst | 18 ++++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 doc/api/index.rst create mode 100644 doc/api/libcephfs-java.rst (limited to 'doc/api') diff --git a/doc/api/index.rst b/doc/api/index.rst new file mode 100644 index 00000000..4a017aa8 --- /dev/null +++ b/doc/api/index.rst @@ -0,0 +1,45 @@ +=================== + API Documentation +=================== + + +Ceph Storage Cluster APIs +========================= + +See `Ceph Storage Cluster APIs`_. + +.. _Ceph Storage Cluster APIs: ../rados/api/ + + +Ceph Filesystem APIs +==================== + +See `libcephfs (javadoc)`_. + +.. _libcephfs (javadoc): libcephfs-java + + +Ceph Block Device APIs +====================== + +See `librbdpy`_. + +.. _librbdpy: ../rbd/api/librbdpy + +Ceph RADOS Gateway APIs +======================= + +See `librgw-py`_. + +.. _librgw-py: ../radosgw/api + +Ceph Object Store APIs +====================== + +- See `S3-compatible API`_. +- See `Swift-compatible API`_. +- See `Admin Ops API`_. + +.. _S3-compatible API: ../radosgw/s3/ +.. _Swift-compatible API: ../radosgw/swift/ +.. _Admin Ops API: ../radosgw/adminops diff --git a/doc/api/libcephfs-java.rst b/doc/api/libcephfs-java.rst new file mode 100644 index 00000000..83b5a663 --- /dev/null +++ b/doc/api/libcephfs-java.rst @@ -0,0 +1,18 @@ +=================== +Libcephfs (JavaDoc) +=================== + +.. warning:: + + CephFS Java bindings are no longer tested by CI. They may not work properly + or corrupt data. + + Developers interested in reviving these bindings by fixing and writing tests + are encouraged to contribute! + +.. + The admin/build-docs script runs Ant to build the JavaDoc files, and + copies them to api/libcephfs-java/javadoc/. + + +View the auto-generated `JavaDoc pages for the CephFS Java bindings `_. -- cgit v1.2.3