diff options
author | Dan Winship <danw@gnome.org> | 2013-12-11 12:13:52 +0100 |
---|---|---|
committer | Dan Winship <danw@gnome.org> | 2013-12-11 12:13:52 +0100 |
commit | f0f3d6aeeba584fd795168f93c30de474585da1d (patch) | |
tree | f96c35f2c14a00641999508b64d0dc3dab8d04f0 /docs | |
parent | c2d0f8d19eb25f21838a1ddfd4baab1c0218ac9c (diff) | |
download | libsoup-f0f3d6aeeba584fd795168f93c30de474585da1d.tar.gz |
Misc docs updates
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/Makefile.am | 3 | ||||
-rw-r--r-- | docs/reference/client-howto.xml | 2 | ||||
-rw-r--r-- | docs/reference/libsoup-2.4-sections.txt | 23 | ||||
-rw-r--r-- | docs/reference/server-howto.xml | 34 |
4 files changed, 34 insertions, 28 deletions
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index a11ce395..d47693a1 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -44,7 +44,8 @@ IGNORE_HFILES= soup.h soup-enum-types.h \ soup-cache-input-stream.h soup-filter-input-stream.h \ soup-cookie-jar-sqlite.h soup-requester.h soup-tld-private.h \ soup-misc-private.h soup-proxy-uri-resolver.h \ - soup-proxy-resolver-wrapper.h + soup-proxy-resolver-wrapper.h soup-proxy-uri-resolver.h \ + soup-cache-private.h # Images to copy into HTML directory. HTML_IMAGES = diff --git a/docs/reference/client-howto.xml b/docs/reference/client-howto.xml index d4d0f37b..e694cb72 100644 --- a/docs/reference/client-howto.xml +++ b/docs/reference/client-howto.xml @@ -122,7 +122,7 @@ you can specify various additional options: <para> Other properties are also available; see the <link -linked="SoupSession"><type>SoupSession</type></link> documentation for +linkend="SoupSession"><type>SoupSession</type></link> documentation for more details. </para> diff --git a/docs/reference/libsoup-2.4-sections.txt b/docs/reference/libsoup-2.4-sections.txt index ca423328..03d35d4b 100644 --- a/docs/reference/libsoup-2.4-sections.txt +++ b/docs/reference/libsoup-2.4-sections.txt @@ -51,8 +51,10 @@ SOUP_MESSAGE_SERVER_SIDE SOUP_MESSAGE_FIRST_PARTY SOUP_MESSAGE_PRIORITY SOUP_MESSAGE_REQUEST_BODY +SOUP_MESSAGE_REQUEST_BODY_DATA SOUP_MESSAGE_REQUEST_HEADERS SOUP_MESSAGE_RESPONSE_BODY +SOUP_MESSAGE_RESPONSE_BODY_DATA SOUP_MESSAGE_RESPONSE_HEADERS SOUP_MESSAGE_TLS_CERTIFICATE SOUP_MESSAGE_TLS_ERRORS @@ -248,6 +250,8 @@ SOUP_SERVER_TLS_CERTIFICATE SOUP_SERVER_ASYNC_CONTEXT SOUP_SERVER_RAW_PATHS SOUP_SERVER_SERVER_HEADER +SOUP_SERVER_HTTP_ALIASES +SOUP_SERVER_HTTPS_ALIASES <SUBSECTION Standard> SOUP_SERVER SOUP_IS_SERVER @@ -439,11 +443,12 @@ SOUP_SESSION_PROXY_URI SOUP_SESSION_PROXY_RESOLVER SOUP_SESSION_MAX_CONNS SOUP_SESSION_MAX_CONNS_PER_HOST -SOUP_SESSION_USE_NTLM -SOUP_SESSION_SSL_CA_FILE -SOUP_SESSION_SSL_USE_SYSTEM_CA_FILE SOUP_SESSION_TLS_DATABASE +SOUP_SESSION_SSL_USE_SYSTEM_CA_FILE +SOUP_SESSION_SSL_CA_FILE +SOUP_SESSION_SSL_STRICT SOUP_SESSION_ASYNC_CONTEXT +SOUP_SESSION_USE_THREAD_CONTEXT SOUP_SESSION_TIMEOUT SOUP_SESSION_IDLE_TIMEOUT SOUP_SESSION_USER_AGENT @@ -452,10 +457,9 @@ SOUP_SESSION_ADD_FEATURE_BY_TYPE SOUP_SESSION_REMOVE_FEATURE_BY_TYPE SOUP_SESSION_ACCEPT_LANGUAGE SOUP_SESSION_ACCEPT_LANGUAGE_AUTO -SOUP_SESSION_SSL_STRICT SOUP_SESSION_HTTP_ALIASES SOUP_SESSION_HTTPS_ALIASES -SOUP_SESSION_USE_THREAD_CONTEXT +SOUP_SESSION_LOCAL_ADDRESS <SUBSECTION Standard> SOUP_IS_SESSION SOUP_IS_SESSION_CLASS @@ -471,6 +475,7 @@ SoupConnection SoupConnectionState SoupMessageQueue SoupMessageQueueItem +SOUP_SESSION_USE_NTLM </SECTION> <SECTION> @@ -1061,11 +1066,7 @@ SOUP_CACHE_GET_CLASS SoupCacheClass SoupCachePrivate <SUBSECTION Private> -soup_cache_generate_conditional_request -soup_cache_get_cacheability soup_cache_get_type -soup_cache_has_response -soup_cache_send_response SoupCacheResponse SoupCacheability </SECTION> @@ -1217,6 +1218,7 @@ SOUP_VERSION_2_38 SOUP_VERSION_2_40 SOUP_VERSION_2_42 SOUP_VERSION_2_44 +SOUP_VERSION_2_46 <SUBSECTION Private> SOUP_AVAILABLE_IN_2_24 SOUP_AVAILABLE_IN_2_26 @@ -1229,6 +1231,7 @@ SOUP_AVAILABLE_IN_2_38 SOUP_AVAILABLE_IN_2_40 SOUP_AVAILABLE_IN_2_42 SOUP_AVAILABLE_IN_2_44 +SOUP_AVAILABLE_IN_2_46 SOUP_DEPRECATED_IN_2_24 SOUP_DEPRECATED_IN_2_24_FOR SOUP_DEPRECATED_IN_2_26 @@ -1251,6 +1254,8 @@ SOUP_DEPRECATED_IN_2_42 SOUP_DEPRECATED_IN_2_42_FOR SOUP_DEPRECATED_IN_2_44 SOUP_DEPRECATED_IN_2_44_FOR +SOUP_DEPRECATED_IN_2_46 +SOUP_DEPRECATED_IN_2_46_FOR SOUP_ENCODE_VERSION SOUP_VERSION_CUR_STABLE SOUP_VERSION_PREV_STABLE diff --git a/docs/reference/server-howto.xml b/docs/reference/server-howto.xml index 76c19182..05fb0c05 100644 --- a/docs/reference/server-howto.xml +++ b/docs/reference/server-howto.xml @@ -100,7 +100,7 @@ to set a callback to handle certain URI paths. <informalexample><programlisting> soup_server_add_handler (server, "/foo", server_callback, - data, destroy_notify); + data, destroy_notify); </programlisting></informalexample> <para> @@ -131,11 +131,11 @@ A handler callback looks something like this: <informalexample><programlisting> static void server_callback (SoupServer *server, - SoupMessage *msg, - const char *path, - GHashTable *query, - SoupClientContext *client, - gpointer user_data) + SoupMessage *msg, + const char *path, + GHashTable *query, + SoupClientContext *client, + gpointer user_data) { ... } @@ -192,11 +192,11 @@ data available at once. <informalexample><programlisting> static void server_callback (SoupServer *server, - SoupMessage *msg, - const char *path, - GHashTable *query, - SoupClientContext *client, - gpointer user_data) + SoupMessage *msg, + const char *path, + GHashTable *query, + SoupClientContext *client, + gpointer user_data) { MyServerData *server_data = user_data; const char *mime_type; @@ -219,7 +219,7 @@ server_callback (SoupServer *server, soup_message_set_status (msg, SOUP_STATUS_OK); soup_message_set_response (msg, mime_type, SOUP_MEMORY_COPY, - body->data, body->len); + body->data, body->len); } </programlisting></informalexample> @@ -264,7 +264,7 @@ is emitted indicating that the previous one was written successfully.) <para> The <emphasis role="bold"><literal>simple-proxy</literal></emphasis> -example in the <literal>tests/</literal> directory gives an example of +example in the <literal>examples/</literal> directory gives an example of using <literal>chunked</literal> encoding. </para> @@ -308,8 +308,8 @@ passed to the <literal>server_callback</literal>: <informalexample><programlisting> static gboolean auth_callback (SoupAuthDomain *domain, SoupMessage *msg, - const char *username, const char *password, - gpointer user_data) + const char *username, const char *password, + gpointer user_data) { MyServerData *server_data = user_data; MyUserData *user; @@ -360,8 +360,8 @@ domains. <para> If you want to require authentication for some requests under a certain path, but not all of them (eg, you want to authenticate -<literal>PUT</literal>s, but not <literal>GET</literal>s), use a -<link +<literal>PUT</literal> requests, but not <literal>GET</literal> +requests), use a <link linkend="SoupAuthDomainFilter"><type>SoupAuthDomainFilter</type></link>. </para> |