Introduce a new HACKING.md document to replace the previous HACKING
ClosedPublic

Authored by graesslin on Dec 15 2018, 12:15 PM.

Details

Summary

This document describes my own practices on how I develop and work on
KWin. Since we have nested KWin/Wayland my ways of developing completely
changed. Especially since it's possible to run without installing. Due
to that I thought it's a good idea to document how one can easily build
and run KWin.

Why a new document in the source tree instead of the wiki?

The main reason for using a wiki was that it allows to format, to link,
etc. This was prior to markdown and prior to code hosting places like
github or phabricator rendering the markdown pages. Given that I think
the information belongs in the repository and not in an external wiki.

Why not fix the existing page?

Our documentation on the wiki is quite outdated:

  • Qt 4 based
  • only X11
  • reviewboard
  • information about file structure which does not match reality

Especially the last point is where I think we need to do a clean cut and
just drop such information. Documentation about code belongs in the code
and not detached in wiki. It will outdate.

How to prevent this document will not become outdated?

Of course difficult. But I tried to not describe anything which might
change, such as file layout, etc.

Diff Detail

Repository
R108 KWin
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
graesslin created this revision.Dec 15 2018, 12:15 PM
Restricted Application added a project: KWin. · View Herald TranscriptDec 15 2018, 12:15 PM
Restricted Application added a subscriber: kwin. · View Herald Transcript
graesslin requested review of this revision.Dec 15 2018, 12:15 PM
zzag added a subscriber: zzag.Dec 15 2018, 5:30 PM
zzag added inline comments.
HACKING.md
96

kdelibs is kinda old. Maybe the Frameworks coding style? https://techbase.kde.org/Policies/Frameworks_Coding_Style

Overall, cool.

I should probably sort out the plasma ones sometime

HACKING.md
62

KWin's own capabilities of using the nested compositor are superior to containers.

This last sentence doesn't make much sense, they're unrelated.
If you're in a container (and not a VM) you would still use a nested compositor.

zzag added inline comments.Dec 15 2018, 7:18 PM
HACKING.md
62

If you're in a container (and not a VM) you would still use a nested compositor.

Well, no, you can run kwin_x11 --replace in a container (you would need to share the X11 socket with the container).

davidedmundson added inline comments.Dec 15 2018, 7:50 PM
HACKING.md
62

Sure, you can do that too.
But that still doesn't make the original sentence make sense.

graesslin updated this revision to Diff 47723.Dec 17 2018, 4:39 PM
  • frameworks coding style (didn't know that existed)
  • reworded the container section
davidedmundson accepted this revision.Dec 17 2018, 4:49 PM
This revision is now accepted and ready to land.Dec 17 2018, 4:49 PM
This revision was automatically updated to reflect the committed changes.