fr/Désignation de fichier dans lxr.conf

Écrire des chemins de fichier adéquats dans lxr.conf est quelque peu difficile mais c'est la clef d'une configuration sans défaut: quand écrire des chemins absolus? quand écrire des chemins relatifs? quelle est l'origine des chemins relatifs?

Pour répondre à ces questions, il faut d'abord comprendre la destination des différents chemins de fichier.

LXR s'appuye sur:

un générateur de page en HTML "pur"
Les références de fichiers depuis du code HTML pur peuvent être écrites sous forme HTML absolue (commençant par une barre oblique /) ou HTML relative (pas de barre oblique initiale).

Les références HTML soit disant absolues sont relatives à DocumentRoot, tandis que celles HTML relatives commencent dans le répertoire du document courant (en omettant le chemin partiel entre DocumentRoot et ce répertoire).
Notez que le "document courant" peut ne pas exister si le code HTML pur est immergé dans une page créée dynamiquement. Selon le serveur web, ce peut être ou non le fichier de script. En raison de cette incertitude, la forme HTML absolue devrait être utilisée dans les pages dynamiques.
Avec certaines configurations complexes du serveur web (e.g. un serveur avec des règles AliasMatch vers un répertoire distinct de DocumentRoot), aucun des deux paradigmes n'est suffisant sans l'aide de l'information <base> dans les en-têtes de page. Cette balise HTML donne une indication au serveur web pour la résolution des références HTML relatives.
Pour pouvoir fonctionner dans un environnement complexe, LXR émet systématiquement un élément <base> ancré dans le répertoire racine de LXR.
ses propres scripts Perl
Les scripts Perl sont exécutés dans leur environnement particulier. Ils savent depuis quel répertoire ils ont été invoqués, mais celui-ci n'a aucune relation implicite avec DocumentRoot. Pour éviter autant que possible des chemins absolus (ce qui gênerait un déplacement aisé des scripts), ils utilisent la possibilité de référencer les fichiers par rapport au répertoire de script (appelé répertoire racine de LXR dans les autres pages de ce site). Ces références seront appelés LXR relatives.
Des utilisateurs de distributions de la famille Debian, dont notamment Ubuntu, ont signalé des dysfonctionnements avec des chemins relatifs. En conséquence, comme le déplacement des scripts LXR est plutôt rare, il est recommandé d'utiliser systématiquement des chemins absolus. L'assistant de configuration 2.0.3 a été modifié pour ne produire que des chemins absolus.
des programmes auxiliaires (comme glimpse)
Ces programmes auxiliaires peuvent être rangés n'importe où dans l'ordinateur, complètement ignorants du serveur web, de Perl ou de LXR. Ils sont aussi exécutés en tant que processus indépendants. Le seul moyen de les désigner est d'utiliser des chemins absolus.

Maintenant, nous pouvons classifier les chemins de fichier.

Paramètres HTML pur
Comme ces paramètres sont susceptibles d'être utilisés par pratiquement toutes les pages, dont l'emplacement est imprévisible, il vous est fortement recommandé d'employer une forme HTML absolue pour leur désignation. Vous devez donc placer le fichier ou le répertoire dans la hiérarchie DocumentRoot si elle n'est pas la même que le répertoire racine de LXR (ce qui est le cas si vous voulez que LXR soit une partie d'un site plus vaste, à la place d'un site dédié).

Sinon, laissez le fichier ou le répertoire dans le répertoire racine de LXR et utilisez une forme HTML relative. Grâce à la résolution par <base>, les formes HTML relative et LXR relative coïncident.

'stylesheet' 'alternate_stylesheet'

copiés dans une balise <LINK REL="alternate stylesheet" … > dans la section <HEAD> de la page, ce qui entraîne que vous devez placer le fichier lxr.css à un endroit adéquat.

'sourceaccess'

utilisé pour permettre au serveur web d'accéder aux fichiers source.

'iconfolder'

répertoire contenant les fichiers d'icone.
Paramètres relatifs à LXR

'html*' '*head' '*tail'

Tous les modèles sont lus par les scripts Perl de LXR et traités en interne pour émettre ensuite du code HTML pur.

'filetypeconf'

lu au démarrage.

'genericconf'

lu par l'analyseur générique à son initialisation.
Paramètres absolus

'tmpdir'

répertoire des fichiers temporaires de LXR.

'glimpsebin' 'glimpseindex' 'glimpsedirbase' 'glimpsedir'

le nécessaire pour glimpse.

'swishbin' 'swishdirbase' 'swishdir' 'swishconf'

le nécessaire pour swish-e.

'ectagsbin' 'ectagsconf'

le nécessaire pour ectags. Notez que, bien que ectags.conf puisse être niché profondément à l'intérieur de la bibliothèque de LXR, il est utilisé exclusivement par ectags, ce qui explique pourquoi ce doit être un chemin absolu.

'cvspath' 'gitpath' 'svnpath' 'hgpath' 'bkpath'

un ensemble de répertoires où trouver les outils des moteurs de stockage (cvs, git, Subversion, Mercurial ou BitKeeper).

'sourceroot' 'sourcetext'

emplacement de l'arbre source (dépôt et répertoire d'extraction).

D'autres paramètres, comme 'virtroot', ressemblent à des chemins de fichiers mais sont des chemins partiels d'URL.