[haiku-commits] haiku: hrev48737 - in docs/user/net/images: . docs/user docs/user/net
- From: jscipione@xxxxxxxxx
- To: haiku-commits@xxxxxxxxxxxxx
- Date: Wed, 28 Jan 2015 01:18:15 +0100 (CET)
hrev48737 adds 3 changesets to branch 'master'
old head: 3cf6e692c8765ed73e9e773659756220a4f9630a
new head: b1a9f638daa96471328f57f385ff17a9dee760b2
overview:
http://cgit.haiku-os.org/haiku/log/?qt=range&q=b1a9f638daa9+%5E3cf6e692c876
----------------------------------------------------------------------------
7177815b2038: Use regular bullets for lists, matches User Guide
d04b3b772c65: Remove trailing . from titles
b1a9f638daa9: Add preliminary Net Kit intro by Philippe Houdoin
From here:
http://philippe.houdoin.free.fr/phil/beos/openbeos/network_kit/overview.html
[ John Scipione <jscipione@xxxxxxxxx> ]
----------------------------------------------------------------------------
7 files changed, 86 insertions(+), 6 deletions(-)
docs/user/Doxyfile | 1 +
docs/user/app/_app_intro.dox | 2 +-
docs/user/book.css | 5 +-
docs/user/book.dox | 35 ++++++++++++++
docs/user/interface/_interface_intro.dox | 2 +-
docs/user/net/_network_intro.dox | 47 +++++++++++++++++++
docs/user/net/images/obos_net_stack_design_1.gif | Bin 0 -> 17731 bytes
############################################################################
Commit: 7177815b2038cb77c1dd9e8bfbb16e4cef795723
URL: http://cgit.haiku-os.org/haiku/commit/?id=7177815b2038
Author: John Scipione <jscipione@xxxxxxxxx>
Date: Wed Jan 28 00:14:36 2015 UTC
Use regular bullets for lists, matches User Guide
----------------------------------------------------------------------------
diff --git a/docs/user/book.css b/docs/user/book.css
index 720e30b..d6102a8 100644
--- a/docs/user/book.css
+++ b/docs/user/book.css
@@ -350,11 +350,8 @@ div.contents hr {
display: none;
}
-div.contents ul {
- list-style: none;
-}
-
div.contents li {
+ line-height: 1.3;
margin-bottom: 10px;
margin-left: 20px;
}
############################################################################
Commit: d04b3b772c6517db7af649b3ac4c82c0fb8496e7
URL: http://cgit.haiku-os.org/haiku/commit/?id=d04b3b772c65
Author: John Scipione <jscipione@xxxxxxxxx>
Date: Wed Jan 28 00:15:11 2015 UTC
Remove trailing . from titles
----------------------------------------------------------------------------
diff --git a/docs/user/app/_app_intro.dox b/docs/user/app/_app_intro.dox
index ac9aaee..ec40ad1 100644
--- a/docs/user/app/_app_intro.dox
+++ b/docs/user/app/_app_intro.dox
@@ -8,7 +8,7 @@
/*!
- \page app_intro Introduction to the Application Kit.
+ \page app_intro Introduction to the Application Kit
The Application Kit should be your starting point if you want to write
native Haiku applications with a GUI. The application kit does
diff --git a/docs/user/interface/_interface_intro.dox
b/docs/user/interface/_interface_intro.dox
index 0f36cef..abc2930 100644
--- a/docs/user/interface/_interface_intro.dox
+++ b/docs/user/interface/_interface_intro.dox
@@ -8,7 +8,7 @@
/*!
- \page interface_intro Introduction to the Interface Kit.
+ \page interface_intro Introduction to the Interface Kit
The Interface Kit holds all the classes you'll need to develop a GUI.
Building on the messaging facilities provided by the Application Kit,
############################################################################
Revision: hrev48737
Commit: b1a9f638daa96471328f57f385ff17a9dee760b2
URL: http://cgit.haiku-os.org/haiku/commit/?id=b1a9f638daa9
Author: John Scipione <jscipione@xxxxxxxxx>
Date: Wed Jan 28 00:16:54 2015 UTC
Add preliminary Net Kit intro by Philippe Houdoin
From here:
http://philippe.houdoin.free.fr/phil/beos/openbeos/network_kit/overview.html
----------------------------------------------------------------------------
diff --git a/docs/user/Doxyfile b/docs/user/Doxyfile
index 5a64a35..3ba6f77 100644
--- a/docs/user/Doxyfile
+++ b/docs/user/Doxyfile
@@ -766,6 +766,7 @@ IMAGE_PATH = . \
interface/images \
keyboard \
midi2/images \
+ net/images \
storage/images
# The INPUT_FILTER tag can be used to specify a program that doxygen should
diff --git a/docs/user/book.dox b/docs/user/book.dox
index 72f751d..1487069 100644
--- a/docs/user/book.dox
+++ b/docs/user/book.dox
@@ -471,9 +471,44 @@ snooze_until(time - Latency(), B_SYSTEM_TIMEBASE);
\defgroup libmidi2 (libmidi2.so)
+
\defgroup network Network Kit
\brief Classes that deal with all network connections and
communications.
+ The Haiku Network Kit consists of:
+ - A modular, add-ons based network stack
+ - Two shared libraries, libnet.so and libnetapi.so
+ - A stack driver, acting as interface between the network stack and
+ libnet.so
+ - Basic network apps
+ - A modular GUI preflet
+
+ The libnet.so shared library is the way that BeOS R5 provided POSIX/BSD
+ API sockets to apps. Being binary compatible with BeOS R5 has made this
+ library implementation tedious. To counter this, the libnetapi.so shared
+ library was developed. It contains thin C++ classes wrapping the C
+ sockets POSIX/BSD API into these BNet* classes we're used under BeOS.
+
+ The stack driver is the interface between libnet.so and the real stack
+ behind it, hosted by the network stack kernel modules. Its purposes
+ include:
+ -# Providing sockets to file descriptors translation support
+ -# Providing support for select() on sockets
+ -# Loading the network stack on first access, and then keeping it for
+ further accesses
+
+ The following diagram illustrates the network stack design on Haiku:
+
+ \image html obos_net_stack_design_1.gif
+
+ The Network Kit includes a handful of useful networking related apps
+ including ping, ifconfig, route, traceroute, and arp.
+
+ See the User Guide for more information about the
+ <a
href="http://haiku-os.org/docs/userguide/en/preferences/network.html";>Network
preferences app</a>
+ included as part of the Network Kit.
+
+
\defgroup storage Storage Kit
\brief Collection of classes that deal with storing and retrieving
information from disk.
diff --git a/docs/user/net/_network_intro.dox b/docs/user/net/_network_intro.dox
new file mode 100644
index 0000000..97d1c4e
--- /dev/null
+++ b/docs/user/net/_network_intro.dox
@@ -0,0 +1,47 @@
+/*
+ * Copyright 2004 Philippe Houdoin
+ * Copyright 2009-2015 Haiku, Inc. All rights reserved.
+ * Distributed under the terms of the MIT License.
+ *
+ * Authors:
+ * Philippe Houdoin
+ * John Scipione, jscipione@xxxxxxxxx
+ */
+
+
+/*!
+ \page network_intro Introduction to the Network Kit
+
+ The Haiku Network Kit consists of:
+ - A modular, add-ons based network stack
+ - Two shared libraries, libnet.so and libnetapi.so
+ - A stack driver, acting as interface between the network stack and
+ libnet.so
+ - Basic network apps
+ - A modular GUI preflet
+
+ The libnet.so shared library is the way that BeOS R5 provided POSIX/BSD
+ API sockets to apps. Being binary compatible with BeOS R5 has made this
+ library implementation tedious. To counter this, the libnetapi.so shared
+ library was developed. It contains thin C++ classes wrapping the C
+ sockets POSIX/BSD API into these BNet* classes we're used under BeOS.
+
+ The stack driver is the interface between libnet.so and the real stack
+ behind it, hosted by the network stack kernel modules. Its purposes
+ include:
+ -# Providing sockets to file descriptors translation support
+ -# Providing support for select() on sockets
+ -# Loading the network stack on first access, and then keeping it for
+ further accesses
+
+ The following diagram illustrates the network stack design on Haiku:
+
+ \image html obos_net_stack_design_1.gif
+
+ The Network Kit includes a handful of useful networking related apps
+ including ping, ifconfig, route, traceroute, and arp.
+
+ See the User Guide for more information about the
+ <a
href="http://haiku-os.org/docs/userguide/en/preferences/network.html";>Network
preferences app</a>
+ included as part of the Network Kit.
+*/
diff --git a/docs/user/net/images/obos_net_stack_design_1.gif
b/docs/user/net/images/obos_net_stack_design_1.gif
new file mode 100644
index 0000000..d08644e
Binary files /dev/null and b/docs/user/net/images/obos_net_stack_design_1.gif
differ
Other related posts:
