Commit Graph

37 Commits

Author SHA1 Message Date
Adrien Destugues
a5061ecec5 Generate developer docs with Sphinx
An effort was started some time ago to consolidate all internal
documentation in the git tree. However, this was just an accumulation of
files in various formats without any strucutre or way to browse it,
which results in no one even knowing that we have docs here.

This converts most of the files to restructuredtext and uses Sphinx to
generate an HTML browsable user manual (with a table of content and a
first attempt to put things in a global hierarchy).

There are almost no changes to the documentation content in this commit
(some obviously obsolete things were removed). The plan is to get the
toolchain up and running to make these docs easily available, and only
then see about improving the content. We can migrate some things off the
wiki and website, and rework the table of contents to have some more
hierarchy levels because currently it's a bit messy.

Change-Id: I924ac9dc6e753887ab56f18a09bdb0a1e1793bfd
Reviewed-on: https://review.haiku-os.org/c/haiku/+/4370
Reviewed-by: Niels Sascha Reedijk <niels.reedijk@gmail.com>
2021-08-27 11:41:17 +00:00
Augustin Cavalier
e81a954787 docs/develop: Mass directory restructure.
Now vaguely follows the tree structure of "src", with the exception of
directories that described subsystems spanning more than one "kit" or
"server" (e.g. "media", "midi", "bluetooth") -- these have been left as their
own top-level directory within docs/develop.
2018-01-10 16:12:14 -05:00
luroh
a09b074d3e Cleanup app_server built-in fonts
We bundle bitstream charter as a default font to use when nothing else
is available. We also used to bundle a Courier font, but it does not
work properly.

- Fix the license for Bitstream Charter, to include just the license and
no extra text.
- Add said license to AboutSystem
- Remove the Courier font from the package and from the source tree.

Fixes #11696.
2017-04-30 13:55:36 +02:00
Stephan Aßmus
d01c27d4f1 * documenting small addition to protocoll when handling flat vector icon data
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@19190 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-11-03 09:41:20 +00:00
Ingo Weinhold
6bfd06d1ff BRoster::Launch() eventually launches the application in question
in several steps:
1. early pre-registration with the registrar ("I wanna launch the
   app, make sure noone interferes.")
2. load the app image
3. finish pre-registration with the registrar ("I have launched
   the app, here is its team ID.")
4. start app main thread
5. send "on launch" messages to the app (argv, refs, others)

If the app is already running or being launched, 1. fails with a
conclusive error code and returns the team ID and the pre-registration
token of the app. Steps 2 - 4 are skipped and only the messages are
delivered using the team ID returned by 1.

This change fixes a race condition: The failed early pre-registration
request obviously cannot return the team ID, if the other thread
launching the app has not finished step 3 yet. Thus the argv/refs
message would not get delivered and Launch() would not return the
correct team ID.

Now we wait for the pre-registration to be finished in this case, using
the former _IsAppPreRegistered() mechanism, which already provided
such a waiting feature for one request. It has been extended to
accomodate an arbitrary number of waiting requests and renamed to
_IsAppRegistered().

This fixed bug #763.



git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18728 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-08-31 17:54:16 +00:00
Ingo Weinhold
15424f3d37 Finally fixed update_mime_info(). As Be's version it understands two
different "force" levels now and updates the app file info attributes
for shared object files.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@16123 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-01-28 19:41:07 +00:00
Ingo Weinhold
2fd4a0411b Added a boolean "synchronous" parameter to BRoster::Shutdown(). Used in the
Deskbar to initiate the shutdown process asynchronously. Couldn't test it,
because opening the Be menu doesn't work:
***PANIC: BW: Can't find view with ID: 19 !***



git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@13722 a95241bf-73f2-0310-859d-f6bbb57e9c96
2005-07-17 16:37:11 +00:00
Ingo Weinhold
a13df0dc01 Added a "confirm" parameter to BRoster::Shutdown() which causes the registrar
to ask the user to confirm shutting down the system.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@13563 a95241bf-73f2-0310-859d-f6bbb57e9c96
2005-07-09 20:23:28 +00:00
Ingo Weinhold
925d069d23 * Added BRoster::ShutDown().
* Adjusted the shutdown command to use BRoster::ShutDown(). Removed
  the alert.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@13416 a95241bf-73f2-0310-859d-f6bbb57e9c96
2005-07-03 17:04:47 +00:00
DarkWyrm
e2c2a10c48 Another good, free Bitstream font for our use
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@4180 a95241bf-73f2-0310-859d-f6bbb57e9c96
2003-08-01 18:35:50 +00:00
DarkWyrm
94cb09f31a added documentation for system fonts added to the tree
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@4179 a95241bf-73f2-0310-859d-f6bbb57e9c96
2003-08-01 18:25:18 +00:00
DarkWyrm
e16ebaf892 Added documentation for BGET manager pool allocator for app_server
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@2699 a95241bf-73f2-0310-859d-f6bbb57e9c96
2003-02-12 23:58:24 +00:00
Ingo Weinhold
79cf70b37a Minor changes.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@2654 a95241bf-73f2-0310-859d-f6bbb57e9c96
2003-02-08 00:35:13 +00:00
Ingo Weinhold
3e103b0660 Added protocols for the Disk Device API.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@2619 a95241bf-73f2-0310-859d-f6bbb57e9c96
2003-02-01 21:07:25 +00:00
DarkWyrm
a92481e9ef Going to Doxygen documentation system for server docs
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@2343 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-12-31 22:20:52 +00:00
DarkWyrm
dd2607d81b 3 new classes
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@2177 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-12-07 21:42:16 +00:00
DarkWyrm
d5d7a2437a Many, many API updates
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@2176 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-12-07 21:39:48 +00:00
DarkWyrm
6b3d681ece Checkin for Gabe Yoder
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@1827 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-11-02 23:46:01 +00:00
Ingo Weinhold
97b8908160 Added message constants for roster watching.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@1576 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-10-18 14:03:54 +00:00
Ingo Weinhold
647a02fc24 B_REG_BROADCAST protocol (BRoster::Broadcast()).
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@1538 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-10-15 22:29:05 +00:00
DarkWyrm
7be1a1b833 Added system cursor support to CursorManager
Added some more classes to server for redraw and desktop management


git-svn-id: file:///srv/svn/repos/haiku/trunk/current@1504 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-10-12 23:31:49 +00:00
Ingo Weinhold
e50950a254 Added protocols for the message runner communication.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@1499 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-10-12 22:38:01 +00:00
Ingo Weinhold
b083d5092f New protocol B_REG_SET_SIGNATURE (BRoster::SetSignature()).
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@1432 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-10-07 21:47:40 +00:00
Tyler Dauwalder
5a628d215b Brought mime update protocols up to speed
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@1279 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-09-29 07:19:34 +00:00
DarkWyrm
83a57b389a Many misc. updates, including a couple new font classes
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@1163 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-09-24 22:49:57 +00:00
Tyler Dauwalder
2f1ee757aa + Added B_REG_MIME_UPDATE_MIME_INFO_ASYNC and
B_REG_MIME_ASYNC_THREAD_FINISHED.
+ Tweaked some wording.


git-svn-id: file:///srv/svn/repos/haiku/trunk/current@1148 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-09-24 05:24:42 +00:00
DarkWyrm
0f107fa327 Added Desktop, TokenHandler, and WinBorder class specs
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@1094 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-09-19 23:56:12 +00:00
DarkWyrm
fb49720446 Initial checkin
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@955 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-09-02 00:14:11 +00:00
Ingo Weinhold
730441c856 Removed B_REG_MIME_UNSUPPORT_TYPE.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@940 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-08-30 20:01:30 +00:00
Ingo Weinhold
a17e6b6813 Added entry for B_REG_MIME_UNSUPPORT_TYPES.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@876 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-08-25 22:40:20 +00:00
Tyler Dauwalder
541ae3c35c Update B_REG_MIME_SUPPORTED_TYPES
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@857 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-08-24 04:47:51 +00:00
Tyler Dauwalder
810bdfb6a4 Details, details, details... ;-)
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@850 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-08-21 22:20:53 +00:00
Tyler Dauwalder
7385178729 Updated REG_MIME_FILE_EXTENSIONS
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@846 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-08-21 10:52:47 +00:00
Tyler Dauwalder
58c767c5f1 + Updated B_REG_MIME_SET_PARAM
+ Added B_REG_MIME_DELETE_PARAM


git-svn-id: file:///srv/svn/repos/haiku/trunk/current@832 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-08-20 09:34:01 +00:00
Tyler Dauwalder
8b5dd33e12 + Added "standard general result reply"
+ Brought MIME database protocols up to date
+ Reformatted the standard reply section very slightly
  to match the rest of the protocols.


git-svn-id: file:///srv/svn/repos/haiku/trunk/current@816 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-08-19 08:34:13 +00:00
Ingo Weinhold
75524bbf28 Changed the return value for CompleteRegistration() from B_REG_APP_NOT_REGISTERED to B_REG_APP_NOT_PRE_REGISTERED, when the application is nor registered at all or already fully registered.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@491 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-07-28 13:31:54 +00:00
Ingo Weinhold
65b9bf3dda Registrar communication protocols added.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@487 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-07-28 00:37:39 +00:00