Fix URLs in the development docs

* Fix dead links where possible
* Use online instead of local links to the BeBook

Change-Id: I250117dcccc0026925c56545cca7e3b4467f2c78
Reviewed-on: https://review.haiku-os.org/c/811
Reviewed-by: Adrien Destugues <[email protected]>
This commit is contained in:
Humdinger
2019-01-29 16:12:55 +00:00
committed by waddlesplash
parent 80cdc887fa
commit e705c841d7
15 changed files with 44 additions and 62 deletions
+3 -6
View File
@@ -12,13 +12,10 @@
<p>Probably the best resource for a description of the inner workings of BFS is the
book "Practical File System Design with the Be File System" written by Dominic
Giampaolo and published by Morgan Kaufmann Publishers. Although that book is out of
print, it's available as a free download from
<A HREF="http://www.letterp.com/~dbg/">Dominic's web site</A>.
print, it's available at the <A HREF="https://www.haiku-os.org/legacy-docs/practical-file-system-design.pdf">Haiku web site</A>.
<p>If you prefer to see how it works in code, please have a look at Haiku's BFS
implementation - you can find that in the SVN repository under
src/add-ons/kernel/file_systems/bfs/. This code is not mature yet, but is considered
to be fairly stable.
<p>If you prefer to see how it works in code, please have a look at <A HREF="https://git.haiku-os.org/haiku/tree/src/add-ons/kernel/file_systems/bfs">Haiku's BFS
implementation</A>.
<p>If you are interested in the Haiku file system API, please refer to its documentation
as part of the Haiku book.
@@ -23,7 +23,7 @@ The document has the following sections:</P>
<P>The BClipboard class provides an interface to a named, system-wide, temporary storage resource.
Access to the system clipboard is provided by the be_clipboard variable provided by a BApplication object (or by constructing a clipboard with the name "system").
The best source of information for the BClipboard interface can be found
<A HREF="file:///boot/beos/documentation/Be%20Book/The%20Application%20Kit/Clipboard.html">here in the Be Book</A>.
<A HREF="https://www.haiku-os.org/legacy-docs/bebook/BClipboard.html">here in the Be Book</A>.
</P>
<A NAME="usecases"></A><H2>BClipboard Use Cases:</H2>
@@ -21,7 +21,7 @@ The document has the following sections:</P>
<A NAME="interface"></A><H2>BCursor Interface:</H2>
<P>The BCursor class is a simple class used to represent a mouse cursor as an object instead of an array of pixel data. The best source of information for the BCursor interface can be found
<A HREF="file:///boot/beos/documentation/Be%20Book/The%20Application%20Kit/Cursor.html">here in the Be Book</A>.
<A HREF="https://www.haiku-os.org/legacy-docs/bebook/BCursor_Overview.html#BCursor_Overview_CursorDataFormat">here in the Be Book</A>.
</P>
<A NAME="usecases"></A><H2>BCursor Use Cases:</H2>
@@ -30,7 +30,7 @@ The document has the following sections:</P>
<OL>
<LI><P><B>Construction 1:</B> The first BCursor constructor requires a pointer to the pixel data. The format for the pixel data is described
<A HREF="file:///boot/beos/documentation/Be%20Book/The%20Application%20Kit/Cursor.html#Cursor_Data_Format">here in the Be Book</A>.
<A HREF="https://www.haiku-os.org/legacy-docs/bebook/BCursor_Overview.html">here in the Be Book</A>.
This pixel data is used to initialize the BCursor, but BCursor does not take ownership of the data, therefore you are responsible for freeing the memory after construction.</P></LI>
<LI><P><B>Construction 2:</B> The second BCursor constructor requires a BMessage as an archive, however BCursor does not currently support archiving. Do not use this constructor.</P></LI>
@@ -24,7 +24,7 @@ The document has the following sections:</P>
<P>The BMessageFilter class is a simple class for processing incoming BMessage's before
they are dispatched to a BLooper. The best source of information for the BMessageFilter interface
can be found
<A HREF="file:///boot/beos/documentation/Be%20Book/The%20Application%20Kit/MessageFilter.html">here in the Be Book</A>.
<A HREF="https://www.haiku-os.org/legacy-docs/bebook/BMessageFilter.html">here in the Be Book</A>.
</P>
<A NAME="usecases"></A><H2>BMessageFilter Use Cases:</H2>
@@ -23,7 +23,7 @@ The document has the following sections:</P>
<P>The BMessageQueue class is a simple class for managing a queue of BMessages. The best
source of information for the BMessageQueue interface can be found
<A HREF="file:///boot/beos/documentation/Be%20Book/The%20Application%20Kit/MessageQueue.html">here in the Be Book</A>.
<A HREF="https://www.haiku-os.org/legacy-docs/bebook/BMessageQueue.html">here in the Be Book</A>.
</P>
<A NAME="usecases"></A><H2>BMessageQueue Use Cases:</H2>
@@ -24,11 +24,11 @@ The document has the following sections:</P>
<P>The BPropertyInfo class is a simple class for describing the scripting interface which a
BHandler provides. It makes implementing the ResolveSpecifier() hook function easier to implement.
One source of information for the BPropertyInfo interface can be found
<A HREF="file:///boot/beos/documentation/Be%20Book/The%20Application%20Kit/PropertyInfo.html">here in the Be Book</A>.
<A HREF="https://www.haiku-os.org/legacy-docs/bebook/BPropertyInfo.html">here in the Be Book</A>.
Unfortunately, details of some changes to this interface introduced in BeOS 4 does not seem to have
made it into the BeBook. For the latest, refer to the
<A HREF="file:///boot/develop/headers/be/app/PropertyInfo.h">PropertyInfo.h</A> header file or the
<A HREF="http://www.acm.uiuc.edu/bug/Be%20Book/Release_Notes/R4RN_AppKit.html">BeOS 4 Developer Release Notes</A>.
<A HREF="file:///system/develop/headers/be/app/PropertyInfo.h">PropertyInfo.h</A> header file or the
<A HREF="http://pulkomandy.tk/~beosarchive/unsorted/cypresstwist/BeOS/Docs/BeBook/Release_Notes/R4RN_AppKit.html ">BeOS 4 Developer Release Notes</A>.
</P>
<A NAME="usecases"></A><H2>BPropertyInfo Use Cases:</H2>
@@ -23,7 +23,7 @@ The document has the following sections:</P>
<P>The BDeskbar class is a simple class for getting information from the deskbar and for modifying
it from your application. The best source of source of information for the BDeskbar interface can be found
<A HREF="file:///boot/beos/documentation/Be%20Book/Deskbar/Deskbar.html">here in the Be Book</A>.
<A HREF="https://www.haiku-os.org/legacy-docs/bebook/BDeskbar.html">here in the Be Book</A>.
</P>
<A NAME="usecases"></A><H2>BDeskbar Use Cases:</H2>
@@ -41,7 +41,7 @@ persists.</P></LI>
<LI><P><B>Add Item 1:</B> The AddItem() member function can be used to take a passed in pointer to
a BView and send it to the deskbar for inclusion in its shelf. This BView must be archivable
and must be exported by the application (for details on how to do this,
<A HREF="http://bedriven.be-in.org/articles/replicant/III_027-stepping%20up%20to%20the%20deskbar.html">this article</A>
<A HREF="https://www.haiku-os.org/legacy-docs/benewsletter/Issue4-27.html#DevWorkshop4-27">this article</A>
may help). The item will be added and the id of the new item will be passed back to the caller
through a pointer to an int32.</P></LI>
@@ -49,10 +49,10 @@ through a pointer to an int32.</P></LI>
shelf by passing a pointer to an entry_ref. The file pointed to by this entry_ref should be
an addon that exports the symbol "BView *instantiate_deskbar_item(float, float)". This entry point is used to
get a BView which it can display in the shelf. More information on this mechanism can be found in
the <A HREF="file:///boot/beos/documentation/Be%20Book/Release%20Notes/Deskbar.html">Deskbar Release Notes</A>
but not in the Be Book proper. The item id of the added item is passed back in an int32 pointer
provided by the caller. NOTE: The source code for the deskbar found in
<A HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/opentracker/opentracker/deskbar/StatusView.cpp?rev=1.5&content-type=text/vnd.viewcvs-markup">TReplicantTray::LoadAddon()</A>
the <A HREF="http://www.tycomsystems.com/beos/BeBook/Release%20Notes/Deskbar.html">Deskbar Release Notes</A> but not in the Be Book proper. The item id of the added item is passed back in an int32 pointer
provided by the caller.<BR />
NOTE: The source code for the Deskbar found in
<A HREF="https://git.haiku-os.org/haiku/tree/src/apps/deskbar/StatusView.cpp?id=f10faf61aca9496c0c2cfa04deb1acf47164b650#n625">TReplicantTray::LoadAddon()</A>
indicates that it also looks for a symbol called "BView *instantiate_deskbar_entry(image_id, entry_ref*, float, float)"
first, but there is no documentation on this.</P></LI>
@@ -122,23 +122,8 @@ when in left or right top position.</P></LI>
<A NAME="implement"></A><H2>BDeskbar Implementation:</H2>
<P>Internally, the BDeskbar uses a BMessenger to communicate with the deskbar itself.
The source code from the OpenTracker project will be used as a reference for this effort.
You can find the deskbar source code here:</P>
<BLOCKQUOTE>
<A HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/opentracker/opentracker/deskbar/">http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/opentracker/opentracker/deskbar/</A>
</BLOCKQUOTE>
<P>Specifically, the code which handles communicating with the BDeskbar class can be found
here:</P>
<BLOCKQUOTE>
<A HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/opentracker/opentracker/deskbar/BarWindow.cpp?rev=1.2&content-type=text/vnd.viewcvs-markup">http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/opentracker/opentracker/deskbar/BarWindow.cpp?rev=1.2&amp;content-type=text/vnd.viewcvs-markup</A>
</BLOCKQUOTE>
<P>The following describes the messages used to communicate between BDeskbar and the deskbar
itself.</P>
<P>Internally, the BDeskbar uses a BMessenger to communicate with the deskbar itself.<BR />
<A HREF="https://git.haiku-os.org/haiku/tree/src/apps/deskbar/BarWindow.cpp">The code which handles communicating with the BDeskbar</A> is described below.</P>
<H3>AddItem:</H3>
@@ -175,7 +160,7 @@ theMsg.AddInt32("id", theID); // This is the id of the new item
<P>Note that in both cases, the deskbar does not set the what code of the reply. Checking the
source code for
<A href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/opentracker/opentracker/deskbar/BarWindow.cpp?rev=1.2&content-type=text/vnd.viewcvs-markup">TBarWindow::AddItem()</A>
<A href="https://git.haiku-os.org/haiku/tree/src/apps/deskbar/BarWindow.cpp?id=f10faf61aca9496c0c2cfa04deb1acf47164b650#n571">TBarWindow::AddItem()</A>
confirms this.
@@ -200,7 +185,7 @@ theMsg.AddBool("exists", IDorNameExists()); // This is a true/false value whi
<P>Note that the deskbar does not set the what code of the reply. Checking the source code
for
<A href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/opentracker/opentracker/deskbar/BarWindow.cpp?rev=1.2&content-type=text/vnd.viewcvs-markup">TBarWindow::ItemExists()</A>
<A href="https://git.haiku-os.org/haiku/tree/src/apps/deskbar/BarWindow.cpp?id=f10faf61aca9496c0c2cfa04deb1acf47164b650#n513">TBarWindow::ItemExists()</A>
confirms this.</P>
@@ -227,7 +212,7 @@ theMsg.AddInt32("id", theID); // This is the id corresponding to the nam
<P>Note that the deskbar does not set the what code of the reply. Checking the source code
for
<A href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/opentracker/opentracker/deskbar/BarWindow.cpp?rev=1.2&content-type=text/vnd.viewcvs-markup">TBarWindow::ItemInfo()</A>
<A href="https://git.haiku-os.org/haiku/tree/src/apps/deskbar/BarWindow.cpp?id=f10faf61aca9496c0c2cfa04deb1acf47164b650#n486">TBarWindow::ItemInfo()</A>
confirms this.</P>
@@ -23,8 +23,8 @@ The document has the following sections:</P>
<P>The BPolygon class is used to hold information about a shape composed of a series of straight
lines (ie a polygon). On its own, it just describes the shape and can only be drawn by passing
it to a BView. The best source of source of information for the BPolygon interface can be found
<A HREF="file:///boot/beos/documentation/Be%20Book/The%20Interface%20Kit/Polygon.html">here in the Be Book</A>.
it to a BView. The best source of source of information for the BPolygon is
<A HREF="https://www.haiku-os.org/legacy-docs/bebook/BPolygon.html">the Be Book page about it</A>.
</P>
<A NAME="usecases"></A><H2>BPolygon Use Cases:</H2>
@@ -90,13 +90,13 @@ The Registrar has three threads:
<hr>
<b>Links:</b>
<ul>
<li> <a href='http://www.beatjapan.org/mirror/www.be.com/users/iconworld/icon5.html'>Icon World -- The Registrar</a>
<li> <a href='http://www.beosbible.com/exc_filetype.html'>The BeOS Bible -- File Typing and The Registrar</a>
<li> <a href='http://bang.dhs.org/be/bebook/The%20Application%20Kit/Application.html'>BApplication</a>
<li> <a href='http://bang.dhs.org/be/bebook/The%20Storage%20Kit/MimeType.html'>BMimeType</a>
<li> <a href='http://bang.dhs.org/be/bebook/Release%20Notes/StorageKit.html'>BMimeType (sniffer docs)</a>
<li> <a href='http://bang.dhs.org/be/bebook/The%20Application%20Kit/Roster.html'>BRoster</a>
<li> <a href='http://testou.free.fr/www.beatjapan.org/mirror/www.be.com/users/iconworld/icon5.html'>Icon World -- The Registrar</a>
<li> <a href='https://birdhouse.org/beos/bible/exc_filetype.html'>The BeOS Bible -- File Typing and The Registrar</a>
<li> <a href='https://www.haiku-os.org/legacy-docs/bebook/BApplication.html'>BApplication</a>
<li> <a href='https://www.haiku-os.org/legacy-docs/bebook/BMimeType.html'>BMimeType</a>
<li> <a href='http://www.tycomsystems.com/beos/BeBook/Release%20Notes/StorageKit.html'>BMimeType (sniffer docs)</a>
<li> <a href='https://www.haiku-os.org/legacy-docs/bebook/BRoster.html'>BRoster</a>
</font>
</body>
</html>
</html>
@@ -22,8 +22,8 @@ The document has the following sections:</P>
<A NAME="interface"></A><H2>BAutolock Interface:</H2>
<P>The BAutolock class is a simple class for handling synchronization between threads. The best
source of information for the BAutolock interface can be found
<A HREF="file:///boot/beos/documentation/Be%20Book/The%20Support%20Kit/Autolock.html">here in the Be Book</A>.
source of information for the BAutolock interface can be found in
<A HREF="https://www.haiku-os.org/legacy-docs/bebook/BAutolock.html">the Be Book documentation</A>.
</P>
<A NAME="usecases"></A><H2>BAutolock Use Cases:</H2>
@@ -23,7 +23,7 @@ The document has the following sections:</P>
<P>The BLocker class is a simple class for handling synchronization between threads. The best
source of information for the BLocker interface can be found
<A HREF="file:///boot/beos/documentation/Be%20Book/The%20Support%20Kit/Locker.html">here in the Be Book</A>.
<A HREF="https://www.haiku-os.org/legacy-docs/bebook/BLocker.html">here in the Be Book</A>.
</P>
<A NAME="usecases"></A><H2>BLocker Use Cases:</H2>
@@ -122,7 +122,7 @@ semaphore which the BLocker represents.</P></LI>
<P>For more information about how to implement a benaphore, you can reference an implementation
found on Be's website at
<A HREF="http://www-classic.be.com/aboutbe/benewsletter/Issue26.html">http://www-classic.be.com/aboutbe/benewsletter/Issue26.html</A>.</P>
<A HREF="https://www.haiku-os.org/legacy-docs/benewsletter/Issue1-26.html">https://www.haiku-os.org/legacy-docs/benewsletter/Issue1-26.html</A>.</P>
@@ -25,7 +25,7 @@ The document has the following sections:</P>
automatically allocated by multiplies of a blocksize you can specify, so it will always be
big enough to contain the data. The best source of information for the BMallocIO interface
can be found
<A HREF="file:///boot/beos/documentation/Be%20Book/The%20Support%20Kit/MemoryIO.html">here in the Be Book</A>.
<A HREF="https://www.haiku-os.org/legacy-docs/bebook/BMemoryIO.html">here in the Be Book</A>.
</P>
<A NAME="usecases"></A><H2>BMallocIO Use Cases:</H2>
@@ -101,4 +101,4 @@ of the buffer.</P></LI>
<A NAME="implement"></A><H2>BMallocIO Implementation:</H2>
</BODY>
</HTML>
</HTML>
@@ -24,7 +24,7 @@ The document has the following sections:</P>
<P>The BMemoryIO class represent a buffer of dynamically allocated memory. You assign the
buffer to a BMemoryIO object on construction. The best source of information for the BMemoryIO interface
can be found
<A HREF="file:///boot/beos/documentation/Be%20Book/The%20Support%20Kit/MemoryIO.html">here in the Be Book</A>.
<A HREF="https://www.haiku-os.org/legacy-docs/bebook/BMemoryIO.html">here in the Be Book</A>.
</P>
<A NAME="usecases"></A><H2>BMemoryIO Use Cases:</H2>
@@ -103,4 +103,4 @@ Seek() Always return the new position.
with an index.</P>
</BODY>
</HTML>
</HTML>
@@ -25,7 +25,7 @@ The document has the following sections:</P>
memory for you so the buffer will always be "big enough" to contain the data.
BString provides a number of charachter search, comparison, and manipulation functions in
a variety of flavors. The best source of information about the BString class can be found
<A HREF="file:///boot/beos/documentation/Be%20Book/The%20Support%20Kit/String.html">here in the Be Book</A>.
<A HREF="https://www.haiku-os.org/legacy-docs/bebook/BString.html">here in the Be Book</A>.
</P>
<A NAME="usecases"></A><H2>BString Use Cases:</H2>
@@ -58,4 +58,4 @@ parameter) of the string pointed by the pointer.</P></LI>
</BODY>
</HTML>
</HTML>
+3 -3
View File
@@ -210,9 +210,9 @@
<hr>
<small>
<a name="foot1">1</a> You can find the definition of the driver interface
in <a href="http://svn.berlios.de/viewcvs/haiku/haiku/branches/team/network/new_stack/headers_private_net/">headers/private/net/net_stack_driver.h</a>, as well as
the driver itself at <a href="http://svn.berlios.de/viewcvs/haiku/haiku/branches/team/network/new_stack/add-ons_kernel_drivers_network_stack/">src/add-ons/kernel/drivers/network/stack/</a><br>
<a name="foot2">2</a><a href="http://svn.berlios.de/viewcvs/haiku/haiku/branches/team/network/new_stack/add-ons_kernel_network/stack/">src/add-ons/kernel/network/stack/</a>
in <a href="https://git.haiku-os.org/haiku/tree/headers/private/net">headers/private/net/net_stack_interface.h</a>, as well as
the driver itself at <a href="https://git.haiku-os.org/haiku/tree/src/add-ons/kernel/drivers/network">src/add-ons/kernel/drivers/network</a><br>
<a name="foot2">2</a><a href="https://git.haiku-os.org/haiku/tree/src/add-ons/kernel/network/stack">src/add-ons/kernel/network/stack/</a>
</small>
</body>
</html>