Commit Graph

34 Commits

Author SHA1 Message Date
Simon Ser
27383a1929 contributing: add section about documentation conventions
Document the existing conventions.

Use `mystruct.foo` instead of `mystruct::foo` because `::` is pretty
alien to C.

Instead of backticks, use a different format to reference declarations
in our docs:

    See foo().
    See struct foo.
    See union bar.
    See enum baz.
    See typedef meh.

This is inspired by the kernel's documentation style [1]. This format
has the upside of being pretty natural to write and read, and can be
automatically processed by documentation generators.

[1]: https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#cross-referencing-from-restructuredtext
2022-05-25 14:22:58 +00:00
Kirill Primak
ec2af17674 CONTRIBUTING.md: update init/finish description 2022-04-28 08:30:26 +00:00
tiosgz
c091a07589 CONTRIBUTING.md: make forks public to let the CI run
This little note helps first-time contributors who are in doubt regarding the
repo visibility.
2022-04-24 17:07:04 +00:00
Kirill Primak
db6661502d CONTRIBUTING.md: update construction/destruction functions' description
wlroots doesn't really follow the rule of keeping `create`/`destroy` and
`init`/`finish` functions in pairs, so the relevant doc section is
updated accordingly.
2022-02-21 15:39:57 +00:00
Kirill Primak
fc1ed72bdc CONTRIBUTING.md: add CoC section 2021-11-06 17:01:53 +03:00
Simon Ser
8bc1086cac s/GitHub/GitLab/ 2021-11-01 18:54:26 +00:00
Hubert Hirtz
d96d2f5f23 Fix a typo in CONTRIBUTING.md 2021-09-24 16:33:26 +02:00
Simon Ser
b0972a94c3 contributing: don't reference issues in commit first line
Commits named "Fix #XXX" make it pretty complicated to figure out
exactly what the commit is doing from the shortlog. A better place
for issue references is in the extended commit message.
2021-09-02 09:31:53 -04:00
Simon Ser
c8d97e2791 Link to gamja for web chat
gamja offers a better experience than Kiwi.
2021-08-30 11:10:11 -04:00
Simon Ser
b18c254e5f contributing: turn remaining links into refs 2021-08-30 16:36:14 +02:00
Simon Ser
1ad3cd7f36 contributing: clone wlroots fork with SSH
HTTPS URLs aren't writable.
2021-08-30 10:31:51 -04:00
Simon Ser
ea800b7418 contributing: use references for links
This avoids cluttering the prose with URLs.
2021-08-30 10:31:51 -04:00
Simon Ser
2ddd8e8036 contributing: add new section about commit log
This is shamelessly stolen from Weston [1].

It's been a while we've transitioned away from merge commits and
work-style commit history, so it'd be nice to mention this in the
docs.

[1]: https://gitlab.freedesktop.org/wayland/weston/-/blob/main/CONTRIBUTING.md#formatting-and-separating-commits
2021-08-30 10:29:33 -04:00
Simon Ser
d0560e2597 contributing: add link to IRC web chat 2021-05-26 22:21:06 +02:00
Simon Zeni
e6c00f7eea Update IRC links 2021-05-24 10:04:17 +02:00
Simon Ser
9b85a8b43d contributing: add note about events that destroy objects 2020-06-08 10:12:38 -06:00
Simon Ser
fd0a845cb4 contributing: resource destroy handlers need to cleanup pointers 2020-06-08 10:12:38 -06:00
Simon Ser
5cde35923c Simplify globals implementation by removing destructors
Some globals are static and it doesn't make sense to destroy them before
the wl_display. For instance, wl_compositor should be created before the
display is started and shouldn't be destroyed.

For these globals, we can simplify the code by removing the destructor
and stop keeping track of wl_resources (these will be destroyed with the
wl_display by libwayland).
2019-11-25 09:01:46 -05:00
emersion
7cbef15206
util: add wlr_ prefix to log symbols 2018-07-09 22:49:54 +01:00
emersion
deeca53e33
Rename wl_resources to resource, wl_global to global 2018-07-08 19:21:31 +01:00
Armin Preiml
e6d613ca2e fix: add stack update on focus change
Enable the stack update again for focus changes on non-focusable views.
2018-07-03 15:03:00 +02:00
emersion
64665200fa
contributing: move wl_resource_set_user_data() right before free() 2018-06-28 14:28:42 +01:00
Genki Sky
d1cf9acbd5 cleanup: Use void for zero-parameter functions
Signed-off-by: Genki Sky <sky@genki.is>
2018-05-30 20:19:16 -04:00
emersion
8676155ae1
Update CONTRIBUTING.md with protocol implementation guidelines 2018-05-03 18:45:27 +01:00
emersion
f9f75a1362
Add prefix policy to CONTRIBUTING.md 2018-04-25 23:00:47 +01:00
Drew DeVault
4267ee2bf3 Update CONTRIBUTING.md 2017-12-27 10:39:53 -05:00
Drew DeVault
b0527e7d48 Update README et al with new links 2017-10-02 22:27:39 -04:00
Scott Anderson
8e45d4beb7 Change to irc.freenode.net 2017-09-30 15:18:40 +13:00
Scott Anderson
bee3560f13 Added example 2017-09-30 15:15:43 +13:00
Scott Anderson
b3dd1b5f95 Changed IRC back to webchat link
Github doesn't support irc:// links, for some stupid reason.
2017-09-30 15:05:41 +13:00
Scott Anderson
deb90ae59d Changed "uninitialised" to "zeroed" 2017-09-30 15:05:41 +13:00
Scott Anderson
e49aed8012 Updated CONTRIBUTING.md
Changed the contribution guidelines to be more consistent with the style
that wlroots has evolved into, and removed some duplicate information
that already exists in the kernel style.
2017-09-30 15:05:41 +13:00
Drew DeVault
a616437c83 Update IRC channel in CONTRIBUTING.md 2017-08-17 08:26:43 -04:00
Drew DeVault
d79f578022 Update README.md, add CONTRIBUTING.md 2017-06-06 10:54:53 -04:00