How to make effective use of the Linux Kernel Documentation directory? [closed] - documentation

Closed. This question needs details or clarity. It is not currently accepting answers.
Want to improve this question? Add details and clarify the problem by editing this post.
Closed 5 years ago.
Improve this question
This may seem like a kind of amorphous question, but how can you get the most of the Linux Kernel Documentation directory?
I noticed on the Linux Cross Reference that there is a DocBook directory. How do I build it, use it and is it at all useful? What other ways are there to make efficient use of this directory?

All the various make targets are documented if you try "make help" at the top of the src tree. In the case of the DocBook stuff there are multiple targets, for example try:
make htmldocs
Oh and yes it is useful stuff and will probably be the most upto date reference around. A lot of the DocBook stuff extracts documentation on the various functions straight from the kernel source tree annotations.

Related

CMake: Should a program be executable out of the build directory? [closed]

Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 18 days ago.
Improve this question
I would like to know if there is any guidance the question below, be it from the official CMake documentation, "industry-standard" or anything the like:
Should a program be executable from the build directory after just the CMake build step?
In other words: If I build my program with CMake and I want to run it. Should I be able to run/use it directly out of the build directory or do a lot of programs only work after an install step for example?
In other, other words: Is the effort to make my program runnable in the build directory a good idea or just unnecessary? What do other programs do? Is there any guidance on this particular question?
In my research I found that it probably should be that way, but I found no actual source for this, that would answer me this. Especially not with any explanation or justification.
Any help is appreciated. Thanks!

Does Zerobrane provide an "include" mechanism? [closed]

Closed. This question needs details or clarity. It is not currently accepting answers.
Want to improve this question? Add details and clarify the problem by editing this post.
Closed 6 years ago.
Improve this question
To Zerobrane users, since this is not a question on lua :
I use Zerobrane for editing lua programs that are to be used with LuaLatex. Very nice !
I make all tests there before using the developments in LuaLatex. So, at the beginning, the programs are run there. I need to tidy up this part, on ZeroBrane, by making files hierarchical, with a master file and slave files around.
Once again, it is a question about ZeroBrane, not about how I use the file within LuaLatex (I know enough about doFile, luaexec and co)
Does this exist ?
I saw PaulK passing by, if he could drop a line, it would be appreciated ...
An "include mechanism" as you call it is usually a language feature, not some feature of an IDE.
Lua provides various functions for running code from other files.
dofile, load, loadfile, require, ...
The most convenient and common is require which will find a file by its name in a given set of directories and execute its contents.
Read this:
https://www.lua.org/manual/5.3/manual.html#6.3
https://www.lua.org/pil/8.1.html
https://www.tutorialspoint.com/lua/lua_modules.htm

How do I verify variables in lua? [closed]

Closed. This question needs details or clarity. It is not currently accepting answers.
Want to improve this question? Add details and clarify the problem by editing this post.
Closed 8 years ago.
Improve this question
I never programmed lua before, now I have to find a part in a script that generates a webinterface and verify a variable, so that it may only contain a valid hostname (only letters and the minus-sign)
How would I program this in lua?
Is there a simple manual, where to find such things (like php.net for PHP)
If you're looking for a simple Lua manual, one exists over at the official page: http://www.lua.org/manual/5.2/
The resource linked by plalx explains the basics of lua pattern matching. So does: http://www.lua.org/pil/20.1.html
Lpeg is a good pattern matching library: http://www.inf.puc-rio.br/~roberto/lpeg/
For a look at other pattern matching libraries, have a look at: http://lua-users.org/wiki/LibrariesAndBindings under the heading "Text Processing"
Try string.match(host,"^[%w%-]+$")~=nil.
I've never programmed in lua either, but it seems that it has a set of powerful pattern matching functions that you could use.
Just have a look at http://lua-users.org/wiki/PatternsTutorial

How to setup coding enviornment over the network [closed]

Closed. This question needs details or clarity. It is not currently accepting answers.
Want to improve this question? Add details and clarify the problem by editing this post.
Closed 8 years ago.
Improve this question
I need to setup the Team Coding Environment i.e. Two or more people, over the local network can code together on a project (PHP coding). How should I get started...
You really don't want to people to work on the same files.
Let both of them work on their own files (locally or on separate folders on a server) and have them use a VCS such as Git. This ensures conflicting modifications do not simply overwrite someone else's code but have to be properly resolved.
You should consider using any kind of SCM (Git, SVN ...) and an IDE which support this SCM (netbeans, eclipse).
Git and Github seems to be the trend of the moment. You should give it a look

Docs with diagrams in github projects? [closed]

Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 5 years ago.
Improve this question
I'd like to write an architecture document for a little ruby project I'm working on, and being an architecture document it'll benefit from a few box and stick diagrams.
What's the done thing on open source projects for this situation? Should I be practicing my ASCII art, or should I include PDFs or something in my doc folder?
Note that this is a stand-alone document, not API documentation generated from the code.
Check out umlet-github, a Google Chrome extension that allows you to create diagrams in UMLet, store them as UXF files in your repository and view them in your browser within the GitHub interface.
I would say use Gliffy, where you can export diagrams to .JPG or .PDF and attach them to your README.md file.
You can also get a sharable link and include it in there. Very handy.