From e705c841d784f0035a0ef3e9e96f6e017df16681 Mon Sep 17 00:00:00 2001 From: Humdinger Date: Tue, 1 Jan 2019 17:53:14 +0100 Subject: [PATCH] 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 --- docs/develop/befs/resources.html | 9 ++--- .../kits/app/usecases/BClipboardUseCases.html | 2 +- .../kits/app/usecases/BCursorUseCases.html | 4 +- .../app/usecases/BMessageFilterUseCases.html | 2 +- .../app/usecases/BMessageQueueUseCases.html | 2 +- .../app/usecases/BPropertyInfoUseCases.html | 6 +-- .../interface/usecases/BDeskbarUseCases.html | 37 ++++++------------- .../interface/usecases/BPolygonUseCases.html | 4 +- docs/develop/kits/storage/RegistrarNotes.html | 14 +++---- .../support/usecases/BAutolockUseCases.html | 4 +- .../support/usecases/BLockerUseCases.html | 4 +- .../support/usecases/BMallocIOUseCases.html | 4 +- .../support/usecases/BMemoryIOUseCases.html | 4 +- .../support/usecases/BStringUseCases.html | 4 +- docs/develop/net/Network Stack Overview.html | 6 +-- 15 files changed, 44 insertions(+), 62 deletions(-) diff --git a/docs/develop/befs/resources.html b/docs/develop/befs/resources.html index 8008424555..fd728e2c34 100644 --- a/docs/develop/befs/resources.html +++ b/docs/develop/befs/resources.html @@ -12,13 +12,10 @@

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 -Dominic's web site. +print, it's available at the Haiku web site. -

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. +

If you prefer to see how it works in code, please have a look at Haiku's BFS +implementation.

If you are interested in the Haiku file system API, please refer to its documentation as part of the Haiku book. diff --git a/docs/develop/kits/app/usecases/BClipboardUseCases.html b/docs/develop/kits/app/usecases/BClipboardUseCases.html index 2322c88871..0baf129394 100644 --- a/docs/develop/kits/app/usecases/BClipboardUseCases.html +++ b/docs/develop/kits/app/usecases/BClipboardUseCases.html @@ -23,7 +23,7 @@ The document has the following sections:

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 -here in the Be Book. +here in the Be Book.

BClipboard Use Cases:

diff --git a/docs/develop/kits/app/usecases/BCursorUseCases.html b/docs/develop/kits/app/usecases/BCursorUseCases.html index 2f2a2fc7dd..ee69ce1108 100644 --- a/docs/develop/kits/app/usecases/BCursorUseCases.html +++ b/docs/develop/kits/app/usecases/BCursorUseCases.html @@ -21,7 +21,7 @@ The document has the following sections:

BCursor Interface:

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 -here in the Be Book. +here in the Be Book.

BCursor Use Cases:

@@ -30,7 +30,7 @@ The document has the following sections:

  1. Construction 1: The first BCursor constructor requires a pointer to the pixel data. The format for the pixel data is described -here in the Be Book. +here in the Be Book. 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.

  2. Construction 2: The second BCursor constructor requires a BMessage as an archive, however BCursor does not currently support archiving. Do not use this constructor.

    3. diff --git a/docs/develop/kits/app/usecases/BMessageFilterUseCases.html b/docs/develop/kits/app/usecases/BMessageFilterUseCases.html index c8d94eea88..e2fc06fe90 100644 --- a/docs/develop/kits/app/usecases/BMessageFilterUseCases.html +++ b/docs/develop/kits/app/usecases/BMessageFilterUseCases.html @@ -24,7 +24,7 @@ The document has the following sections:

    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 -here in the Be Book. +here in the Be Book.

    BMessageFilter Use Cases:

    diff --git a/docs/develop/kits/app/usecases/BMessageQueueUseCases.html b/docs/develop/kits/app/usecases/BMessageQueueUseCases.html index 0c715d04e9..262edcec13 100644 --- a/docs/develop/kits/app/usecases/BMessageQueueUseCases.html +++ b/docs/develop/kits/app/usecases/BMessageQueueUseCases.html @@ -23,7 +23,7 @@ The document has the following sections:

    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 -here in the Be Book. +here in the Be Book.

    BMessageQueue Use Cases:

    diff --git a/docs/develop/kits/app/usecases/BPropertyInfoUseCases.html b/docs/develop/kits/app/usecases/BPropertyInfoUseCases.html index c181904baa..0c4941388f 100644 --- a/docs/develop/kits/app/usecases/BPropertyInfoUseCases.html +++ b/docs/develop/kits/app/usecases/BPropertyInfoUseCases.html @@ -24,11 +24,11 @@ The document has the following sections:

    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 -here in the Be Book. +here in the Be Book. 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 -PropertyInfo.h header file or the -BeOS 4 Developer Release Notes. +PropertyInfo.h header file or the +BeOS 4 Developer Release Notes.

    BPropertyInfo Use Cases:

    diff --git a/docs/develop/kits/interface/usecases/BDeskbarUseCases.html b/docs/develop/kits/interface/usecases/BDeskbarUseCases.html index 96aeceb229..1acedc1355 100644 --- a/docs/develop/kits/interface/usecases/BDeskbarUseCases.html +++ b/docs/develop/kits/interface/usecases/BDeskbarUseCases.html @@ -23,7 +23,7 @@ The document has the following sections:

    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 -here in the Be Book. +here in the Be Book.

    BDeskbar Use Cases:

    @@ -41,7 +41,7 @@ persists.

  3. Add Item 1: 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, -this article +this article 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.

    4. @@ -49,10 +49,10 @@ through a pointer to an int32.

    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 Deskbar Release Notes -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 -TReplicantTray::LoadAddon() +the Deskbar Release Notes 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 +TReplicantTray::LoadAddon() 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.

    @@ -122,23 +122,8 @@ when in left or right top position.

    BDeskbar Implementation:

    -

    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:

    - -
    -http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/opentracker/opentracker/deskbar/ -
    - -

    Specifically, the code which handles communicating with the BDeskbar class can be found -here:

    - -
    -http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/opentracker/opentracker/deskbar/BarWindow.cpp?rev=1.2&content-type=text/vnd.viewcvs-markup -
    - -

    The following describes the messages used to communicate between BDeskbar and the deskbar -itself.

    +

    Internally, the BDeskbar uses a BMessenger to communicate with the deskbar itself.
    +The code which handles communicating with the BDeskbar is described below.

    AddItem:

    @@ -175,7 +160,7 @@ theMsg.AddInt32("id", theID); // This is the id of the new item

    Note that in both cases, the deskbar does not set the what code of the reply. Checking the source code for -TBarWindow::AddItem() +TBarWindow::AddItem() confirms this. @@ -200,7 +185,7 @@ theMsg.AddBool("exists", IDorNameExists()); // This is a true/false value whi

    Note that the deskbar does not set the what code of the reply. Checking the source code for -TBarWindow::ItemExists() +TBarWindow::ItemExists() confirms this.

    @@ -227,7 +212,7 @@ theMsg.AddInt32("id", theID); // This is the id corresponding to the nam

    Note that the deskbar does not set the what code of the reply. Checking the source code for -TBarWindow::ItemInfo() +TBarWindow::ItemInfo() confirms this.

    diff --git a/docs/develop/kits/interface/usecases/BPolygonUseCases.html b/docs/develop/kits/interface/usecases/BPolygonUseCases.html index 826c138876..211b2ac41a 100644 --- a/docs/develop/kits/interface/usecases/BPolygonUseCases.html +++ b/docs/develop/kits/interface/usecases/BPolygonUseCases.html @@ -23,8 +23,8 @@ The document has the following sections:

    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 -here in the Be Book. +it to a BView. The best source of source of information for the BPolygon is +the Be Book page about it.

    BPolygon Use Cases:

    diff --git a/docs/develop/kits/storage/RegistrarNotes.html b/docs/develop/kits/storage/RegistrarNotes.html index 94d59997e6..3ba573f566 100644 --- a/docs/develop/kits/storage/RegistrarNotes.html +++ b/docs/develop/kits/storage/RegistrarNotes.html @@ -90,13 +90,13 @@ The Registrar has three threads:
    Links:
      -
    • Icon World -- The Registrar -
    • The BeOS Bible -- File Typing and The Registrar -
    • BApplication -
    • BMimeType -
    • BMimeType (sniffer docs) -
    • BRoster +
    • Icon World -- The Registrar +
    • The BeOS Bible -- File Typing and The Registrar +
    • BApplication +
    • BMimeType +
    • BMimeType (sniffer docs) +
    • BRoster - \ No newline at end of file + diff --git a/docs/develop/kits/support/usecases/BAutolockUseCases.html b/docs/develop/kits/support/usecases/BAutolockUseCases.html index f4961b2ac2..8e405e044b 100644 --- a/docs/develop/kits/support/usecases/BAutolockUseCases.html +++ b/docs/develop/kits/support/usecases/BAutolockUseCases.html @@ -22,8 +22,8 @@ The document has the following sections:

      BAutolock Interface:

      The BAutolock class is a simple class for handling synchronization between threads. The best -source of information for the BAutolock interface can be found -here in the Be Book. +source of information for the BAutolock interface can be found in +the Be Book documentation.

      BAutolock Use Cases:

      diff --git a/docs/develop/kits/support/usecases/BLockerUseCases.html b/docs/develop/kits/support/usecases/BLockerUseCases.html index 5b3bc91963..270d7349c0 100644 --- a/docs/develop/kits/support/usecases/BLockerUseCases.html +++ b/docs/develop/kits/support/usecases/BLockerUseCases.html @@ -23,7 +23,7 @@ The document has the following sections:

      The BLocker class is a simple class for handling synchronization between threads. The best source of information for the BLocker interface can be found -here in the Be Book. +here in the Be Book.

      BLocker Use Cases:

      @@ -122,7 +122,7 @@ semaphore which the BLocker represents.

      • For more information about how to implement a benaphore, you can reference an implementation found on Be's website at -http://www-classic.be.com/aboutbe/benewsletter/Issue26.html.

      +https://www.haiku-os.org/legacy-docs/benewsletter/Issue1-26.html.

      diff --git a/docs/develop/kits/support/usecases/BMallocIOUseCases.html b/docs/develop/kits/support/usecases/BMallocIOUseCases.html index bf6bb78077..e6f9cd738d 100644 --- a/docs/develop/kits/support/usecases/BMallocIOUseCases.html +++ b/docs/develop/kits/support/usecases/BMallocIOUseCases.html @@ -25,7 +25,7 @@ The document has the following sections:

      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 -here in the Be Book. +here in the Be Book.

      BMallocIO Use Cases:

      @@ -101,4 +101,4 @@ of the buffer.

      BMallocIO Implementation:

      - \ No newline at end of file + diff --git a/docs/develop/kits/support/usecases/BMemoryIOUseCases.html b/docs/develop/kits/support/usecases/BMemoryIOUseCases.html index 38ce5e3994..6de21f2ab4 100644 --- a/docs/develop/kits/support/usecases/BMemoryIOUseCases.html +++ b/docs/develop/kits/support/usecases/BMemoryIOUseCases.html @@ -24,7 +24,7 @@ The document has the following sections:

      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 -here in the Be Book. +here in the Be Book.

      BMemoryIO Use Cases:

      @@ -103,4 +103,4 @@ Seek() Always return the new position. with an index.

      - \ No newline at end of file + diff --git a/docs/develop/kits/support/usecases/BStringUseCases.html b/docs/develop/kits/support/usecases/BStringUseCases.html index 03290ca6d7..0ead374f25 100644 --- a/docs/develop/kits/support/usecases/BStringUseCases.html +++ b/docs/develop/kits/support/usecases/BStringUseCases.html @@ -25,7 +25,7 @@ The document has the following sections:

      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 -here in the Be Book. +here in the Be Book.

      BString Use Cases:

      @@ -58,4 +58,4 @@ parameter) of the string pointed by the pointer.

      - \ No newline at end of file + diff --git a/docs/develop/net/Network Stack Overview.html b/docs/develop/net/Network Stack Overview.html index 010755ad2f..001dbe4e66 100644 --- a/docs/develop/net/Network Stack Overview.html +++ b/docs/develop/net/Network Stack Overview.html @@ -210,9 +210,9 @@
      1 You can find the definition of the driver interface - in headers/private/net/net_stack_driver.h, as well as - the driver itself at src/add-ons/kernel/drivers/network/stack/
      - 2src/add-ons/kernel/network/stack/ + in headers/private/net/net_stack_interface.h, as well as + the driver itself at src/add-ons/kernel/drivers/network
      + 2src/add-ons/kernel/network/stack/