luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 15:06:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'volume-docs' into 'main'

Browse Source 
docs: Clarify distinction between GDrive, GVolume and GMount

See merge request GNOME/glib!4193
This commit is contained in:
Emmanuele Bassi 2024-08-15 11:06:36 +00:00
commit b540bdd961
4 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference/gio/overview.md
View File

@ -33,10 +33,10 @@ base classes for I/O and files:
: list files in directories
[iface@Gio.Drive]
: represents a drive
: represents a drive, which may contain zero or more volumes
[iface@Gio.Volume]
: represents a file system in an abstract way
: represents a file system, which may have a mount
[iface@Gio.Mount]
: represents a mounted file system

2
gio/gdrive.c
View File

@ -35,7 +35,7 @@
*
* `GDrive` represents a piece of hardware connected to the machine.
* It’s generally only created for removable hardware or hardware with
* removable media.
* removable media. For example, an optical disc drive, or a USB flash drive.
*
* `GDrive` is a container class for [iface@Gio.Volume] objects that stem from
* the same piece of media. As such, `GDrive` abstracts a drive with

14
gio/gmount.c
View File

@ -39,14 +39,15 @@
/**
* GMount:
*
* The `GMount` interface represents user-visible mounts. Note, when
* [porting from GnomeVFS](migrating-gnome-vfs.html), `GMount` is the moral
* equivalent of `GnomeVFSVolume`.
* The `GMount` interface represents a user-visible mount, such as a mounted
* file system.
*
* `GMount` is a ‘mounted’ filesystem that you can access. Mounted is in
* quotes because it’s not the same as a UNIX mount, it might be a GVFS
* mount, but you can still access the files on it if you use GIO. Might or
* might not be related to a volume object.
* mount, but you can still access the files on it if you use GIO.
*
* A `GMount` might be associated with a [iface@Gio.Volume] (such as a USB flash
* drive) which hosts it.
*
* Unmounting a `GMount` instance is an asynchronous operation. For
* more information about asynchronous operations, see [iface@Gio.AsyncResult]
@ -60,6 +61,9 @@
* operation was completed successfully. If an `error` is present when
* [method@Gio.Mount.unmount_with_operation_finish] is called, then it will be
* filled with any error information.
*
* Note, when [porting from GnomeVFS](migrating-gnome-vfs.html), `GMount` is the
* moral equivalent of `GnomeVFSVolume`.
**/
typedef GMountIface GMountInterface;

10
gio/gvolume.c
View File

@ -35,8 +35,11 @@
* GVolume:
*
* The `GVolume` interface represents user-visible objects that can be
* mounted. Note, when [porting from GnomeVFS](migrating-gnome-vfs.html),
* `GVolume` is the moral equivalent of `GnomeVFSDrive`.
* mounted. For example, a file system partition on a USB flash drive, or an
* optical disc inserted into a disc drive.
*
* If a `GVolume` is currently mounted, the corresponding [iface@Gio.Mount] can
* be retrieved using [method@Gio.Volume.get_mount].
*
* Mounting a `GVolume` instance is an asynchronous operation. For more
* information about asynchronous operations, see [iface@Gio.AsyncResult] and
@ -58,6 +61,9 @@
* [method@Gio.Volume.mount_finish] is called, then it will be filled with any
* error information.
*
* Note, when [porting from GnomeVFS](migrating-gnome-vfs.html),
* `GVolume` is the moral equivalent of `GnomeVFSDrive`.
*
* ## Volume Identifiers
*
* It is sometimes necessary to directly access the underlying