route: Document ROUTE_CACHE_CONTENT flag

Signed-off-by: Thomas Graf <tgraf@suug.ch>

diff --git a/include/netlink/route/route.h b/include/netlink/route/route.h
index 5729cd746dcc81b86d8f003511070fc93c453478..d3543af3edeb59f72f29cedf0e826f2021ee64f3 100644 (file)
--- a/include/netlink/route/route.h
+++ b/include/netlink/route/route.h
@@ -6,7 +6,7 @@
  *     License as published by the Free Software Foundation version 2.1
  *     of the License.
  *
- * Copyright (c) 2003-2008 Thomas Graf <tgraf@suug.ch>
+ * Copyright (c) 2003-2012 Thomas Graf <tgraf@suug.ch>
  */
 
 #ifndef NETLINK_ROUTE_H_
@@ -24,7 +24,12 @@
 extern "C" {
 #endif
 
-/* flags */
+/**
+ * @ingroup route
+ * When passed to rtnl_route_alloc_cache() the cache will
+ * correspond to the contents of the routing cache instead
+ * of the actual routes.
+ */
 #define ROUTE_CACHE_CONTENT    1
 
 struct rtnl_route;

diff --git a/lib/route/route.c b/lib/route/route.c
index f684f96ce8f7836f25aa70f40cb1ffa02cb80750..2218a604dad5e3afba02641dca27659498e1c0ae 100644 (file)
--- a/lib/route/route.c
+++ b/lib/route/route.c
@@ -69,6 +69,10 @@ static int route_request_update(struct nl_cache *c, struct nl_sock *h)
  * Allocates a new cache, initializes it properly and updates it to
  * contain all routes currently configured in the kernel.
  *
+ * Valid flags:
+ *   * ROUTE_CACHE_CONTENT - Cache will contain contents of routing cache
+ *                           instead of actual routes.
+ *
  * @note The caller is responsible for destroying and freeing the
  *       cache after using it.
  * @return 0 on success or a negative error code.