doc: various doc cleanup for distcheck.

Author: chergert

doc/mongoc_stream.txt

@@ -53,11 +53,16 @@ OpenSSL based TLS support with x509 certificate verification.
 The TLS stream type has a few non-standard methods that involve negotiating the
 SSL handshake and cert verification.
 
-UNIX
+FILE
 ~~~~
 
-The bread and butter stream type.  This can correlate to a unix domain socket
-or a tcp socket.
+A stream for communicating with local files on disk.
+
+SOCKET
+~~~~~~
+
+The primary stream interface. This is used for communicating with a a peer
+over an AF_INET, AF_INET6, or AF_UNIX socket.
 
 
 SEE ALSO
@@ -70,10 +75,13 @@ linkmongoc:mongoc_stream_buffered_new[3]
 linkmongoc:mongoc_stream_close[3]
 linkmongoc:mongoc_stream_cork[3]
 linkmongoc:mongoc_stream_destroy[3]
+linkmongoc:mongoc_stream_file_new[3]
+linkmongoc:mongoc_stream_file_new_for_path[3]
 linkmongoc:mongoc_stream_flush[3]
 linkmongoc:mongoc_stream_gridfs_new[3]
 linkmongoc:mongoc_stream_read[3]
 linkmongoc:mongoc_stream_readv[3]
+linkmongoc:mongoc_stream_socket_new[3]
 linkmongoc:mongoc_stream_setsockopt[3]
 linkmongoc:mongoc_stream_tls_check_cert[3]
 linkmongoc:mongoc_stream_tls_do_handshake[3]
@@ -86,6 +94,9 @@ RELATED
 ~~~~~~~
 
 linkmongoc:mongoc_client[7]
+linkmongoc:mongoc_socket[7]
+linkmongoc:mongoc_stream_file[7]
+linkmongoc:mongoc_stream_socket[7]
 
 
 AUTHORS

doc/mongoc_stream_file.txt

@@ -1,57 +1,47 @@
-mongoc_stream_file(3)
+mongoc_stream_file(7)
 =====================
 
 
 NAME
 ----
-mongoc_stream_file_new, mongoc_stream_file_new_for_path, mongoc_stream_file_get_fd - create a new mongoc file stream
+mongoc_stream_file - MongoDB stream IO abstraction for local files
 
 
 SYNOPSIS
 --------
-[source,c]
------------------------
-mongoc_stream_t *mongoc_stream_file_new          (int              fd);
-mongoc_stream_t *mongoc_stream_file_new_for_path (const char      *path,
-                                                  int              flags,
-                                                  int              mode);
-int              mongoc_stream_file_get_fd       (mongoc_stream_t *stream);
------------------------
 
+[source, c]
+---------------
+#include <mongoc.h>
 
-DESCRIPTION
------------
-The _mongoc_stream_file_new()_ function shall create a new 
-linkmongoc:mongoc_stream[7], taking ownership of the file-descriptor _fd_.
+typedef struct _mongoc_stream_file_t mongoc_stream_file_t;
+---------------
 
-fd::
-   The file descriptor to take ownership of.
-   fd will be closed when the stream is disposed.
 
+DESCRIPTION
+-----------
+_mongoc_stream_file_t_ can be considered a subclass of _mongoc_stream_t_. It
+is used for local files using a UNIX style file-descriptor.
 
-The _mongoc_stream_file_new_for_path()_ function shall create a new 
-linkmongoc:mongoc_stream[7], using the path, flags and mode provided.
-This calls _open()_ and the semantics are the same.
 
+SEE ALSO
+--------
 
-RETURN VALUE
-------------
-The _mongoc_stream_file_new()_ and _mongoc_stream_file_new_for_path()_
-functions return a new linkmongoc:mongoc_stream[7].
+FUNCTIONS
+~~~~~~~~~
 
-The _mongoc_stream_file_get_fd()_ returns the underlying file-descriptor.
+linkmongoc:mongoc_stream_file_new[3]
+linkmongoc:mongoc_stream_file_new_for_path[3]
+linkmongoc:mongoc_stream_file_new_get_fd[3]
 
-ERRORS
-------
-No errors are defined.
 
+RELATED
+~~~~~~~
 
-SEE ALSO
---------
 linkmongoc:mongoc_stream[7]
+linkmongoc:mongoc_client[7]
 
 
 AUTHORS
 -------
-
 This page was written by MongoDB, Inc.

doc/mongoc_stream_file_get_fd.txt

@@ -0,0 +1,37 @@
+mongoc_stream_file_get_fd(3)
+============================
+
+
+NAME
+----
+mongoc_stream_file_get_fd - Get underlying file descriptor for file stream
+
+
+SYNOPSIS
+--------
+[source,c]
+-----------------------
+int mongoc_stream_file_get_fd (mongoc_stream_t *stream);
+-----------------------
+
+
+DESCRIPTION
+-----------
+The _mongoc_stream_file_get_fd()_ function shall return the underlying
+file descriptor used by a _mongoc_stream_file_t_.
+
+
+RETURN VALUE
+------------
+A file descriptor or -1 if the file has been closed.
+
+
+SEE ALSO
+--------
+linkmongoc:mongoc_stream[7]
+linkmongoc:mongoc_stream_file[7]
+
+
+AUTHORS
+-------
+This page was written by MongoDB, Inc.

doc/mongoc_stream_file_get_fd.txt

@@ -0,0 +1,58 @@
+mongoc_stream_file_new(3)
+=========================
+
+
+NAME
+----
+mongoc_stream_file_new, mongoc_stream_file_new_for_path - create a new mongoc file stream
+
+
+SYNOPSIS
+--------
+[source,c]
+-----------------------
+mongoc_stream_t *mongoc_stream_file_new          (int              fd);
+mongoc_stream_t *mongoc_stream_file_new_for_path (const char      *path,
+                                                  int              flags,
+                                                  int              mode);
+-----------------------
+
+
+DESCRIPTION
+-----------
+The _mongoc_stream_file_new()_ function shall create a new 
+linkmongoc:mongoc_stream[7], taking ownership of the file-descriptor _fd_.
+
+fd::
+   The file descriptor to take ownership of.
+   fd will be closed when the stream is disposed.
+
+
+The _mongoc_stream_file_new_for_path()_ function shall create a new 
+linkmongoc:mongoc_stream[7], using the path, flags and mode provided.
+This calls _open()_ and the semantics are the same.
+
+
+RETURN VALUE
+------------
+The _mongoc_stream_file_new()_ and _mongoc_stream_file_new_for_path()_
+functions return a new linkmongoc:mongoc_stream[7].
+
+If there was a failure to open the file, NULL is returned and errno
+is set.
+
+
+ERRORS
+------
+errno is set if NULL is returned.
+
+
+SEE ALSO
+--------
+linkmongoc:mongoc_stream[7]
+linkmongoc:mongoc_stream_file[7]
+
+
+AUTHORS
+-------
+This page was written by MongoDB, Inc.

doc/mongoc_stream_file_new.txt

@@ -1 +1 @@
-mongoc_stream_file.txt
+mongoc_stream_file_new.txt