Inadequate documentation of binaries

[Alan Griffiths]

User feedback "I had compiled Mir and had binaries but there was no documentation of what the produced binaries were or how to use them"

[Thomas Voß (thomas-voss)]

Is this addressed by publishing build and installation instructions on http://unity.ubuntu.com/mir/.

If we want to address this issue, adequate needs to be defined from my pov.

[Kevin DuBois (kdub)]

+1 to thomas's comments... maybe incomplete is the right bug state?

[Daniel van Vugt (vanvugt)]

Yeah I was the user who gave this feedback originally. I think the bug should still be open because I can't yet find adequate documentation that clearly states things like:

bin/mir is a server. You need this to display the output of clients (apps).

bin/render* are also servers (for testing only). They do not use the primary server bin/mir

bin/mir_whatever are mostly clients. You need a server running before these will work.

Basic stuff like that.

Although I suggest more consistency in the naming of all our examples' binaries would go a long way to making things more clear.

[Alan Griffiths (alan-griffiths)]

I think consistency would help a lot.

/1/ Should all the executables start with "mir"?

/2/ Should all the examples start with "mir_demo"?

/3/ Should all the client process demos start with "mir_demo_client"?

/4/ Should all the server process demos start with "mir_demo_server"?

/5/ Would applying the above rules address the bug?

Vis: (Ignoring some test binaries - maybe they too should be renamed)

mir_demo_shell => mir_demo_server_shell
render_surfaces => mir_demo_server_render_surfaces
mir_eglflash => mir_demo_client_eglflash
render_to_fb => mir_demo_server_render_to_fb
mir_eglplasma => mir_demo_client_eglplasma
mir_egltriangle => mir_demo_client_egltriangle
mir_demo_inprocess_egl => mir_demo_server_inprocess_egl
mir_multiwin => mir_demo_client_multiwin
mir_demo_input_filter => mir_demo_server_input_filter

[Robert Ancell (robert-ancell)]

+1 on the mir_demo_* prefixes.

[Alan Griffiths (alan-griffiths)]

Re-reading, I think that "render_*" should go to "mir_demo_standalone_render_*" as they are standalone programs not servers.

[PS Jenkins bot (ps-jenkins)]

Fix committed into lp:mir at revision None, scheduled for release in mir, milestone 0.0.4