Commit Graph
1156 Commits
Author SHA1 Message Date
Augustin Cavalier e702bf57be BQuery: Make SetFlags() behave like other Set..() methods & add documentation. 2025-05-01 12:36:43 -04:00
Augustin Cavalier 01b71d945e BWindow: Clean up dispatch of NO_COMMAND_KEY shortcuts.
Only search once for a shortcut exactly matching the current
modifiers, i.e. whether with or without COMMAND_KEY.

Also clarify some of the comments and logic.
2025-04-25 14:51:29 -04:00
Adrien Destugues 6cb7acc3e9 docs/develop: Fix Doxygen build after previous commit 2025-04-08 12:55:29 +02:00
Adrien Destugues 2e9c9b0173 docs/develop: Fix some internal links in package documentation.
Use references as documented in https://www.sphinx-doc.org/en/master/usage/referencing.html#ref-role

Fixes #19509
2025-04-08 12:51:20 +02:00
PulkoMandy c11bec8ef0 docs/develop: update bootstraping documentation
Add a section about various known problems and be more clear that this
is still unfortunately quite not well tested and experimental.

Change-Id: If8f83682e03f23097edd00a855423febaaff43ce
Reviewed-on: https://review.haiku-os.org/c/haiku/+/9157
Reviewed-by: waddlesplash <[email protected]>
Haiku-Format: Haiku-format Bot <[email protected]>
2025-04-07 21:33:30 +00:00
Adrien Destugues e1bdecd0d7 docs/develop: Import oco's article on profiling applications
- Create a new "debugging" section and move two other articles there as
  well
2025-02-27 13:31:53 +01:00
PulkoMandy 1fbf09c309 Internals documentation: add notes about the process without vendor branches
This is still used in various places, so we should be clear about how it
is supposed to be done. It should avoid people learning from repeating errors
that others have already made.

Change-Id: I2468e51e62658bfad499c22294dd8a34c8aa8c90
2025-02-23 10:35:42 +01:00
Máximo Castañeda 72f8f120b0 API docs: fix syntax
Lack of closing tag discards page for generation.

Change-Id: Ibe5b5618c59a29e063b46d1897145a59ab57c8dc
2025-02-21 13:01:07 +01:00
PulkoMandy 85fc17e562 Migrate syscalls documentation from the website to Haiku internals book
Change-Id: I997049a1e174e7dd346e1342a2513a67e118a93b
2025-02-20 22:38:20 +01:00
Krutarth Patel c8252422b8 Adding device node tree image to Haiku documentation
In the device driver architecture documentation there is a
TODO for adding an image representation of the device node
tree in Haiku.
This patch adds a .svg image for the same, removing the TODO
line.

Change-Id: If5d1e3ee5abe7d6e84245c837b5cb2f1f0cb670a
Reviewed-on: https://review.haiku-os.org/c/haiku/+/8983
Tested-by: Commit checker robot <[email protected]>
Haiku-Format: Haiku-format Bot <[email protected]>
Reviewed-by: nephele nephele <[email protected]>
2025-02-16 21:17:56 +00:00
Augustin Cavalier 7c2bd6bfcd docs/develop: Delete "How to Merge Patches from NetBSD Trunk".
This is now obsolete as the preferred merge strategy is just to
copy the whole directories and then reinstate the __HAIKU__
directives, same as for the FreeBSD network drivers and other
such code.
2025-02-11 00:30:49 -05:00
John Scipione 16c6cc4418 BTextView: Fixup AdoptSystemColors() and HasSystemColors()
Replace private _UsesSystemColors() with public HasSystemColors()
and make sure to consider the tints when checking if system colors
are used or not.

Document HasSytemColors() in the Haiku Book.

Change-Id: I78de4904d5ddb24b98ad27eb93d4e5ccb330d76a
Reviewed-on: https://review.haiku-os.org/c/haiku/+/8897
Haiku-Format: Haiku-format Bot <[email protected]>
Tested-by: Commit checker robot <[email protected]>
Reviewed-by: waddlesplash <[email protected]>
2025-02-03 00:14:52 +00:00
1e2091ced5 Interface Kit: Add support for shortcuts w/o Command
Introduce B_NO_COMMAND_KEY modifier that is used when a
shortcut has no Command modifier, otherwise B_COMMAND_KEY
modifier is added.

This is conceptually different from B_NO_MODIFIERS in that it
allows other modifiers such as B_CONTROL_KEY, B_SHIFT_KEY and
B_OPTION_KEY to be added to a shortcut, but not B_COMMAND_KEY.

This option is required to remove B_COMMAND_KEY because the
Command modifier is assumed to be present on all shortcuts.
This allows us to break this assumption without breaking apps
written before this change and assume B_COMMAND_KEY to be
present even if it has not been explictly added.

Document B_NO_COMMAND_KEY in BMenuItem and BWindow docs.

Fixes #7078

Co-authored-by: X512 <[email protected]>
Co-authored-by: Ryan Leavengood <[email protected]>

Change-Id: If0e20cd848112898f4425ede8c17231dc50deb8a
Reviewed-on: https://review.haiku-os.org/c/haiku/+/7293
Tested-by: Commit checker robot <[email protected]>
Reviewed-by: nephele nephele <[email protected]>
2025-02-02 19:18:35 +00:00
John Scipione 9105063938 BTextView: Use document colors on AdoptSystemColors()
AdoptSystemColors() tints document background color to match panel
color if uneditable.

Calling MakeEditable() will automatically apply or unapply uneditable
background tint if you have previously called AdoptSystemColors().

Parent BView::AdoptSystemColors() sets panel colors, we want document
colors here. Do not alter text color - only view, low and high colors
are changed.

Document AdoptSystemColors() and MakeEditable() in BTextView docs.

Change-Id: Ib215735f27bb01fc2f95fcf2fee0185e5fc83f70
Reviewed-on: https://review.haiku-os.org/c/haiku/+/8263
Haiku-Format: Haiku-format Bot <[email protected]>
Reviewed-by: waddlesplash <[email protected]>
Tested-by: Commit checker robot <[email protected]>
2025-01-17 16:57:38 +00:00
Niklas Poslovski 802fb5b90f Documentation: Replace remaining references of OpenBeOS with Haiku
Fixes #19335

Change-Id: I8458431be907e3f59165c7e9cf43d715e904af3d
Reviewed-on: https://review.haiku-os.org/c/haiku/+/8826
Reviewed-by: John Scipione <[email protected]>
Reviewed-by: waddlesplash <[email protected]>
Haiku-Format: Haiku-format Bot <[email protected]>
2025-01-13 22:23:11 +00:00
Niklas Poslovski ee40fc9747 Documentation: Remove old unused doxygen_config files
Change-Id: I5f29561cea9bf34e1c92a381e6293ccae78c48c7
Reviewed-on: https://review.haiku-os.org/c/haiku/+/8829
Haiku-Format: Haiku-format Bot <[email protected]>
Reviewed-by: waddlesplash <[email protected]>
Reviewed-by: John Scipione <[email protected]>
Tested-by: Commit checker robot <[email protected]>
2025-01-13 22:22:43 +00:00
PawanYr 372d066f2f TeamMonitor: Group teams.
Programs like Iceweasel and Falkon/QTWebEngine spawn lots of processes
that clog up Team monitor. To reduce the clutter, group teams under the BApplication that spawned them.

Groups are collapsed by default, and the tree only goes one level deep.
If a BApp spawns other BApps with the same executable, they are grouped
under it.

Also, fix bug where opening Team monitor before be_roster has info for a
BApp (immediately after launch) can sometimes cause the 'Quit' button to
be incorrectly disabled.

Also, update BOutlineListView::RemoveItem documentation; neither the
BeBook nor the HaikuBook mentioned that these will both remove *and
delete* child items (BeBook mentions removing, HaikuBook mentions
neither), which cost me some time debugging . . .

(a previous version of this patch grouped solely by name)

Change-Id: I29c627fbc905da5b5dc7145589f8da21ae8ba6fe
Reviewed-on: https://review.haiku-os.org/c/haiku/+/8770
Reviewed-by: waddlesplash <[email protected]>
Tested-by: Commit checker robot <[email protected]>
2025-01-10 03:53:34 +00:00
cafeina 102726ea26 Haiku Book: Added GameSound, Shelf
Change-Id: I1377ab80e7128a5406bf9f0523564e5e7f9e9f1b
Reviewed-on: https://review.haiku-os.org/c/haiku/+/8624
Reviewed-by: Adrien Destugues <[email protected]>
Haiku-Format: Haiku-format Bot <[email protected]>
Tested-by: Commit checker robot <[email protected]>
2024-12-22 08:40:35 +00:00
John Scipione 512a94bc18 BTextView docs: Document GetFontAndColor() and SetFontAndColor()
Change-Id: Ie284c63690e955d7cfae7e9e66949a63205e8e31
Reviewed-on: https://review.haiku-os.org/c/haiku/+/8270
Reviewed-by: nephele nephele <[email protected]>
Tested-by: Commit checker robot <[email protected]>
2024-12-21 17:32:52 +00:00
Oscar Lesta fed0e6149e Haiku Book: fix typo on _launch_intro.dox.
launch_daemon only understands "no_safemode".

Change-Id: Ib7efb6064a49c35185ffacba3e8642eacd1fe970
Reviewed-on: https://review.haiku-os.org/c/haiku/+/8686
Reviewed-by: waddlesplash <[email protected]>
Haiku-Format: Haiku-format Bot <[email protected]>
Tested-by: Commit checker robot <[email protected]>
2024-12-18 00:17:12 +00:00
PulkoMandy 344ded80d4 ioctl: Document in Haiku book and in comments
- Convert libroot from a page to a group, so that it can list the
  included file and functions in the generated book (like the kits)
- Add unistd.dox and move the relevant part of ioctl details there
- Make sure to use C89-compatible comments only in POSIX headers

Change-Id: I8f0412e4c75de6f48018a0436909f8b0076342a4
Reviewed-on: https://review.haiku-os.org/c/haiku/+/6369
Reviewed-by: Adrien Destugues <[email protected]>
Haiku-Format: Haiku-format Bot <[email protected]>
2024-11-18 17:12:04 +00:00
drea233 fc7456e9b1 fix typo in "Update keyboard.dox"
Small typo

Signed-off-by: Augustin Cavalier <[email protected]>
2024-10-17 12:10:30 -04:00
Augustin Cavalier ae8d7152a0 docs/develop: Updates to Release Cookbook.
Add/update some steps, etc.
2024-08-20 13:38:10 -04:00
Augustin Cavalier 94c66b276e docs/develop: Rename release "milestones" page to "cookbook".
This more accurately reflects what it contains, as well as
mirrors what it used to be called when it was on Trac.
2024-08-20 13:13:24 -04:00
X512 2141d2fe3a input: fix KEY_power key code conflict with japanese \_ key
- This key code is inherited from BeOS, where it was used for the power
  key on Apple ADB keyboards
- Since then, we have introduced a new system for "multimedia" keys,
  that uses HID key codes directly instead of defining our own mappings
- The PS2 driver was using the HID keycode, but the USB driver was still
  using the BeOS defined one
- Japanese keyboards, which have a few more keys than US and European
  ones, reused the same keycode for something else

Since the power key does not need to be mapped by the keymap, move it
out of the way by using the HID keycode (key codes larger than 0x7f
cannot be mapped to UTF8 symbols). Remove all mentions of the use of
0x6b as a keycode for the power key, but add a note in the documentation
that BeOS did this.

To avoid further confusions, complete the documentation of extra
keycodes, and remove some definitions from keyboard_mouse_driver.h that
should have been in InterfaceDefs.h.

While researching this, I also found that some keys specific to Korean
keyboards were declared in the wrong place, as mapped codes instead of
unmapped ones (checked that by looking at the HID driver, which emits
these raw keycodes, and confirming that the mapped ones are not used in
any keymaps. Also added a note about the mapping of the extra modifier
keys in Japanese keyboards, which I think may be a problem since these
map to invalid UTF-8 byte sequences, but this is what the existing
keymap does, so leaving it as is for now until we can determine if this
can be changed or if we have to keep it that way.

Change-Id: I6a198a0840cba7739bdc78e0c65e5d8fd23956c9
Reviewed-on: https://review.haiku-os.org/c/haiku/+/8047
Tested-by: Commit checker robot <[email protected]>
Reviewed-by: Adrien Destugues <[email protected]>
2024-08-19 16:00:25 +00:00
Humdinger eea5774f46 HIG: add section on "Recently Used Files"
Change-Id: I6d4190adc8a77ce755435f415b6bd281921990d1
Reviewed-on: https://review.haiku-os.org/c/haiku/+/8005
Reviewed-by: waddlesplash <[email protected]>
Haiku-Format: Haiku-format Bot <[email protected]>
Tested-by: Commit checker robot <[email protected]>
2024-08-14 10:49:07 +00:00
Máximo Castañeda caed67a8cb Input server: add mouse-specific API for button map and click speed
Convert users of those and other parameters to the new API.
Fix mouse preferences "Default" button not changing button map.

Change-Id: I9184011fd3067fd0b229e1db6376c1b41f06dab9
Reviewed-on: https://review.haiku-os.org/c/haiku/+/7878
Tested-by: Commit checker robot <[email protected]>
Reviewed-by: waddlesplash <[email protected]>
2024-07-29 17:30:39 +00:00
Augustin Cavalier ba0223da5d Haiku Book: Fix typo in launch_daemon documentation. 2024-07-15 21:17:04 -04:00
Jim906 342a1b221b FAT: revise using code from FreeBSD
* Rewrite most hook functions, modeling many after FreeBSD hooks and
  making use of support functions ported from FreeBSD. As it stands
  now, most of the FreeBSD driver files are present with minimal
  changes, with a pseudo-BSD compatability layer added to make them
  work in Haiku. Performance is not what it could be if the BSD code
  was rewritten to interface directly with the Haiku kernel, but under
  the current approach the driver might be easier to maintain in terms
  of porting future FreeBSD bugfixes.
* Add support for FAT in userlandfs. Aside from being useful for
  debugging, the userlandfs module provides better filename support
  for characters that are not in code page 850, because it can link
  libiconv.
* Update the fat_test.sh script to use dosfstools to format the tested
  device, instead of the internal dosfs_initialize hook. The script
  is written to test specific cluster sizes, but the initialize hook
  still does not support user-specified cluster sizes.
* Coding guidelines: lightly-modified BSD files and lightly-modified
  original Haiku driver files have not been revised to adhere to the
  Haiku style guidelines. For BSD files, this is meant to make it
  easier to compare with the FreeBSD repository when merging future
  FreeBSD patches. For existing driver files, this is to highlight the
  functional changes made in this change request (I can submit a
  separate patch later to clean up style in these files). Also, some
  #include lines are not alphbetized (they are instead ordered like
  they would be in FreeBSD, because one header relies on another).

Change-Id: I92521d4b700d7aa52fe6c664cf8f83a4d9395809
Reviewed-on: https://review.haiku-os.org/c/haiku/+/7660
Reviewed-by: Adrien Destugues <[email protected]>
Tested-by: Commit checker robot <[email protected]>
Reviewed-by: Jérôme Duval <[email protected]>
2024-07-09 06:40:55 +00:00
Máximo Castañeda b8a45b3a2d BFont: allow skipping fallbacks in GetHasGlyphs
Change-Id: I5a68008d25cce34596fb5ce6fb07259ae56c3a3d
Reviewed-on: https://review.haiku-os.org/c/haiku/+/7829
Tested-by: Commit checker robot <[email protected]>
Reviewed-by: Adrien Destugues <[email protected]>
Haiku-Format: Haiku-format Bot <[email protected]>
2024-07-06 13:12:21 +00:00
Zardshard 984f843b91 HaikuBook: document missing BBitmap constructor
Change-Id: I4fc51b0e499f9cb5e5c4ce58d6baddf462322b3f
Reviewed-on: https://review.haiku-os.org/c/haiku/+/7719
Reviewed-by: waddlesplash <[email protected]>
Tested-by: Commit checker robot <[email protected]>
Haiku-Format: Haiku-format Bot <[email protected]>
2024-06-10 16:36:12 +00:00
Pascal Abresch 47c05920fd Docs: Document color_which UI colors
Change-Id: Ic8fef097ac6cc616ae962459c42f93109a1833ae
Reviewed-on: https://review.haiku-os.org/c/haiku/+/7656
Haiku-Format: Haiku-format Bot <[email protected]>
Reviewed-by: Adrien Destugues <[email protected]>
Reviewed-by: nephele nephele <[email protected]>
Tested-by: Commit checker robot <[email protected]>
2024-05-19 08:55:45 +00:00
Adrien Destugues 9f3bdf3d03 rc: migrate documentation to Haiku internals pages 2024-04-29 13:58:59 +02:00
Pascal Abresch 9c274ccd09 Document new rgb_color apis, apply their usage.
Change-Id: I48f1bedd3abfb3b445c1c7090ce43504bcff4537
Reviewed-on: https://review.haiku-os.org/c/haiku/+/7485
Reviewed-by: waddlesplash <[email protected]>
2024-02-28 17:53:38 +00:00
PulkoMandy 2a2e7ad562 doc/user: mention libnetwork and a bit of the filesystem hierarchy
Based on the feedback from Maya Posch in https://mayaposch.wordpress.com/2024/01/20/porting-nymphcast-to-the-haiku-operating-system/
Thanks for noting that the information was missing!

Change-Id: I4a9f709b17cb3a4a771f167b5af0fc83843ec5ad
Reviewed-on: https://review.haiku-os.org/c/haiku/+/7406
Reviewed-by: Niels Sascha Reedijk <[email protected]>
Tested-by: Commit checker robot <[email protected]>
2024-02-20 12:14:51 +00:00
Anant Verma 084e24d0bf docs/develop: minor improvements in the fs section
Change-Id: Ie94dbc1339facbee59080d85b6938f2c160eb05e
Reviewed-on: https://review.haiku-os.org/c/haiku/+/7368
Reviewed-by: Adrien Destugues <[email protected]>
2024-02-02 19:11:31 +00:00
Máximo Castañeda 621200ebbd BOutlineListView: fix ItemUnderAt and accept NULL as superitem
ItemUnderAt was returning items that were not under the superitem (this
was fixed for EachItemUnder in hrev52210).
Make a NULL superitem mean the parent of the topmost items. Despite not
being explicitly documented in the BeBook, that's how BeOS works, the
MenuWorld test app uses it and, well, it's handy.

Change-Id: I2551e8ce874a6238c5e5fb1eb742e68e62d3928a
Reviewed-on: https://review.haiku-os.org/c/haiku/+/7359
Reviewed-by: Adrien Destugues <[email protected]>
2024-01-29 18:58:03 +00:00
Máximo Castañeda d579eb9efe HaikuBook: minor fixes
Fix some copy-pasta and strange grammar.
Remove a note that seems unnecessary in context and easy to misinterpret
out of context.

Change-Id: If1ce26b293c8098c260a9697fb0ef0611a4958c4
Reviewed-on: https://review.haiku-os.org/c/haiku/+/7358
Reviewed-by: Adrien Destugues <[email protected]>
Tested-by: Commit checker robot <[email protected]>
2024-01-29 18:15:16 +00:00
PulkoMandy 1978089f7c API docs: document menu reordering functions
Change-Id: Ic1a914af343aa713cfb7edc813c6a6458cb5027f
Reviewed-on: https://review.haiku-os.org/c/haiku/+/7357
Haiku-Format: Haiku-format Bot <[email protected]>
Reviewed-by: Niels Sascha Reedijk <[email protected]>
2024-01-28 16:12:09 +00:00
Augustin Cavalier 1322e37a03 docs/user: Fix typo. 2024-01-08 14:07:53 -05:00
PulkoMandy da4dbfa47a API docs: document KernelExport.h and overview of synchronization primitives.
Change-Id: Ic3853bf103710f289a32f43f5fb1beb79bca0b9f
Reviewed-on: https://review.haiku-os.org/c/haiku/+/7245
Reviewed-by: waddlesplash <[email protected]>
2023-12-30 18:33:37 +00:00
PulkoMandy e92b4d3a27 docs/develop: add sourcetree layout document
Largely based on a_brief_introduction_to_our_source_repository_layout.html
from the website, revised and updated. I will delete the one from the
website and put a redirect to here once this is merged.

Change-Id: I06657bbea4c16df7bff1f2357cffd2ec8a63c65a
Reviewed-on: https://review.haiku-os.org/c/haiku/+/7236
Reviewed-by: waddlesplash <[email protected]>
Tested-by: Commit checker robot <[email protected]>
2023-12-24 02:56:51 +00:00
John Scipione 82bfaa954d BListView: Add ScrollTo(index) method, auto-scroll on drag
Multi-select lists may also auto-scroll on drag now as well.

Document ScrollTo(index). Give Scrolling its own section.

Change-Id: I36284a28376a01bafd23ddb30162fc786fb41521
Reviewed-on: https://review.haiku-os.org/c/haiku/+/7213
Tested-by: Commit checker robot <[email protected]>
Reviewed-by: Adrien Destugues <[email protected]>
2023-12-24 02:45:59 +00:00
Alexander von Gluck IV 3634f14235 docs/develop/ide: A quick guide for haiku code completion
* Works under a Linux "cross-compile" environment
* We can't check in compile_commands.json unforunetly because it
  highly depends on your build environment
* An in-tree .clangd is a thing, but our includes are complex
  and directory-spefific.
* Thanks to Pulkomandy for adding the flag to jam to do this!

Change-Id: I3be4084c43f7b822bb04ea7ec527c5fbe03d7289
Reviewed-on: https://review.haiku-os.org/c/haiku/+/7158
Tested-by: Commit checker robot <[email protected]>
Reviewed-by: Adrien Destugues <[email protected]>
Reviewed-by: Alex von Gluck IV <[email protected]>
2023-12-05 20:02:07 +00:00
PulkoMandy ae2049aa4f user docs: add note about use of BView::GetMouse() in BView::MouseUp()
Fixes #18606

Change-Id: I2f6d9cd67de6cd4223b6837bb1b8b0cd1de79800
2023-09-30 21:27:32 +02:00
Zardshard c9afad2268 HaikuBook: Improve documentation of AddDynamicItem
Change-Id: Id682c64f13eb103074bdbee34d531d3e2a91de0f
Reviewed-on: https://review.haiku-os.org/c/haiku/+/6955
Reviewed-by: waddlesplash <[email protected]>
2023-09-26 16:40:04 +00:00
Niels Sascha Reedijk d2edfdd11d docs: document the steps to update GCC buildtools
Change-Id: Iaa41194e0f76594efd504b65f3565b22743dce34
2023-08-12 07:59:29 +01:00
Niels Sascha Reedijk e10dd8e99a Dev docs: update instructions on generating build-packages repo
This is now updated for the modern k8s infrastructure.

Change-Id: Ib468eb0bdf4b0746c3f5d8692d9353d0cd9e923a
Reviewed-on: https://review.haiku-os.org/c/haiku/+/6768
Reviewed-by: Adrien Destugues <[email protected]>
2023-08-02 07:09:03 +00:00
Pascal Abresch f11b304632 Document Launch flags and Preference directory for findpath
Change-Id: I150c0ca1e0deb5749689bb1019a48efdcdc99def
Reviewed-on: https://review.haiku-os.org/c/haiku/+/6701
Tested-by: Commit checker robot <[email protected]>
Reviewed-by: Adrien Destugues <[email protected]>
Reviewed-by: nephele nephele <[email protected]>
2023-07-18 16:43:20 +00:00
Niels Sascha Reedijk 4958c5d7b6 HaikuBook: fix some errors and warnings during documentation generation
Change-Id: Ib6b876ff83aeba0d2346990ab2e9869cbf519284
Reviewed-on: https://review.haiku-os.org/c/haiku/+/6641
Tested-by: Commit checker robot <[email protected]>
Reviewed-by: Adrien Destugues <[email protected]>
2023-06-24 22:00:27 +00:00