Quad-Core ARMv7 Build Slave Seeks Noble Purpose

It wouldn’t take me more than an hour or two to do the format conversion. It is rather trivial, actually. Just say the word and I’m on to it like a starving bee. I guess I should get used to using the Sphinx layout; I’m simply more familiar with the format I use on my own websites.

Have you guys ever considered making a less formal wiki for LLVM documentation - a place where tiny snippets and tricks could be stored? A place that anybody could contribute to in such a way that only the Wiki editors could accept or reject a proposed change. Kind of like Wikipedia. http://wiki.llvm.org. If you are short on resources, I’d be happy to volunteer for the task of co-Wiki-editor (this doesn’t require as big knowledge of LLVM as you’d think; it is mostly a matter of rejecting attempts to defame the site and such). If any topic in the Wiki became too complex or too important, somebody could get started on writing the appropriate coherent, user-friendly documentation that could be merged into the main branch of documents.

What if we renamed the ARM document to “TipsForBuildingOnARM” instead of “HowToBuildOnARM”?

It wouldn't take me more than an hour or two to do the format conversion.
It is rather trivial, actually. Just say the word and I'm on to it like a
starving bee. I guess I should get used to using the Sphinx layout; I'm
simply more familiar with the format I use on my own websites.

Have you guys ever considered making a less formal wiki for LLVM
documentation - a place where tiny snippets and tricks could be stored? A
place that anybody could contribute to in such a way that only the Wiki
editors could accept or reject a proposed change. Kind of like Wikipedia.
http://wiki.llvm.org. If you are short on resources, I'd be happy to
volunteer for the task of co-Wiki-editor (this doesn't require as big
knowledge of LLVM as you'd think; it is mostly a matter of rejecting
attempts to defame the site and such). If any topic in the Wiki became too
complex or too important, somebody could get started on writing the
appropriate coherent, user-friendly documentation that could be merged into
the main branch of documents.

Also, I'm not sure how many such "tips and tricks" or "tiny snippets" there
can be (and I'm cautious about how quickly they will go out of date). It's
honestly probably easier for LLVM developers to edit files in the
repository (purely from a workflow perspective).

My biggest reason for opposing such a wiki is that it is decoupled from the
community, which is centered on the mailing lists. A person doesn't have to
get on the mailing lists to submit an edit to such a wiki, which means that
they won't become part of the community whereas in order for them to
contribute to docs/, they have to reach out to the community and send a
patch, which is a gateway drug to further involvement.

What if we renamed the ARM document to "TipsForBuildingOnARM" instead of
"HowToBuildOnARM"?

We currently don't have an easy way to serve a redirect to the new page, so
for the moment we can't rename it (URL's should never break). This is <
http://llvm.org/bugs/show_bug.cgi?id=14714>. Actually now that I think
about it maybe we can do it with a dummy html file with a <meta> tag with
`http-equiv`? Finding a working setup for that is probably a better use of
your time than reformatting. One other page that is in dire need of a
rename is clang/docs/Tooling.rst, which is actually "choosing the right
interface for your application".

-- Sean Silva

It wouldn't take me more than an hour or two to do the format conversion.
It is rather trivial, actually. Just say the word and I'm on to it like a
starving bee. I guess I should get used to using the Sphinx layout; I'm
simply more familiar with the format I use on my own websites.

Have you guys ever considered making a less formal wiki for LLVM
documentation - a place where tiny snippets and tricks could be stored? A
place that anybody could contribute to in such a way that only the Wiki
editors could accept or reject a proposed change. Kind of like Wikipedia.
http://wiki.llvm.org. If you are short on resources, I'd be happy to
volunteer for the task of co-Wiki-editor (this doesn't require as big
knowledge of LLVM as you'd think; it is mostly a matter of rejecting
attempts to defame the site and such). If any topic in the Wiki became too
complex or too important, somebody could get started on writing the
appropriate coherent, user-friendly documentation that could be merged into
the main branch of documents.

Also, I'm not sure how many such "tips and tricks" or "tiny snippets"
there can be (and I'm cautious about how quickly they will go out of date).
It's honestly probably easier for LLVM developers to edit files in the
repository (purely from a workflow perspective).

That "Also," at the beginning was a leftover when I switched the paragraph
order. Please ignore it.

-- Sean Silva

StackOverflows says two things:

  1. An example is: .
  2. This apparently discouraged by the WWW Consortium who recommends server redirects.

It seems that LLVM.org is served by Apache 2.2.22 running on Ubuntu. In that case, the .htaccess file should make it possible to do server redirects:

RewriteEngine On
RewriteRule /docs/HowToBuildOnARM.rst http://www.llvm.org/docs/TipsForBuildingOnARM.rst

I think that’s it. I use NGINX myself so I can’t test it. I don’t think the “http://www.llvm.org” part is necessary.

It’s okay with the manual reformatting; it gives my brain a chance to cool off a bit with relaxed stuff in preparation for going to sleep.

– Mikael

StackOverflows says two things:

    1. An example is: <meta http-equiv="refresh" content="0; url=
http://example.com/" />.
  2. This apparently discouraged by the WWW Consortium who recommends
server redirects.

It seems that LLVM.org is served by Apache 2.2.22 running on Ubuntu. In
that case, the .htaccess file should make it possible to do server
redirects:

   RewriteEngine On
   RewriteRule /docs/HowToBuildOnARM\.rst
http://www.llvm.org/docs/TipsForBuildingOnARM.rst

I think that's it. I use NGINX myself so I can't test it. I don't think
the "http://www.llvm.org" part is necessary.

Yeah, the reason that bug has been open so long is that the "hard" part is
tracking down the server admin, or otherwise finding a way to get the
.htaccess file there (may be Sphinx can copy it to the output directory?).
Then finding some way to reliably test it (or do remote-debugging through
git/svn).

-- Sean Silva

The great thing about .htaccess is that is user-controlled: You simply put one in whichever directory you want to use it in. So no need for a server admin, unless he/she has specifically disabled it somehow (that I don’t know of).

– Mikael