|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
#!/bin/bash
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
#
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9ebc53 |
# document_getEntry.sh -- This function builds a documentation entry based
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
638bf8 |
# on a location specified. Location specification can be both action
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
638bf8 |
# value (ACTIONVAL) variable or a value passed as first positional
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
638bf8 |
# parameter.
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
#
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9f5f2e |
# Copyright (C) 2009-2011 Alain Reguera Delgado
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
#
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
7cd8e9 |
# This program is free software; you can redistribute it and/or
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
7cd8e9 |
# modify it under the terms of the GNU General Public License as
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
7cd8e9 |
# published by the Free Software Foundation; either version 2 of the
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
7cd8e9 |
# License, or (at your option) any later version.
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
#
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
# This program is distributed in the hope that it will be useful, but
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
# General Public License for more details.
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
#
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
# You should have received a copy of the GNU General Public License
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
# along with this program; if not, write to the Free Software
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
# USA.
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
#
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
# ----------------------------------------------------------------------
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
418249 |
# $Id$
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
# ----------------------------------------------------------------------
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9ebc53 |
function document_getEntry {
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
# Define variables as local to avoid conflicts outside.
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
local ENTRY=''
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
638bf8 |
local LOCATION=''
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
638bf8 |
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
638bf8 |
# Redefine location in order to make this function reusable not
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
638bf8 |
# just for action value variable but whatever value passed as
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
638bf8 |
# first possitional argument.
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
638bf8 |
if [[ "$1" != '' ]];then
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
638bf8 |
LOCATION="$1"
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
638bf8 |
else
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
638bf8 |
LOCATION="$ACTIONVAL"
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
638bf8 |
fi
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
5285d6 |
# Define relative path of entry, from trunk directory on.
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
5285d6 |
ENTRY=$(echo $LOCATION | sed -r "s!^${HOME}/artwork/!!")
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
5285d6 |
# Verify the entry relative path to find out which documentation
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
5285d6 |
# manual we are acting on. As convenction, whatever documentation
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
5285d6 |
# entry you provide outside trunk/Manuals/ directory structure is
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
5285d6 |
# considered as you are documenting the repository directory
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
5285d6 |
# structure. Otherwise, if an entry inside trunk/Manuals/ is
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
5285d6 |
# provided, the directory structure provided is used as default
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
5285d6 |
# documentation manual for actions like `--create' and `--update'
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
5285d6 |
# to take place on. Other options like `--edit', `--delete' and
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
5285d6 |
# `--read' cannot be applied to paths provided is inside
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
5285d6 |
# trunk/Manuals/ such actions made manually.
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
966109 |
if [[ ${ENTRY} =~ '\.texi$' ]];then
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
759d18 |
ENTRY=$(echo ${ENTRY} | sed 's!trunk/Manual/!!')
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
5285d6 |
else
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
759d18 |
ENTRY=$(dirname Filesystem/${ENTRY})/$(basename $LOCATION).texi
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
5285d6 |
fi
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
5285d6 |
# Re-define entry to set absolute path to manuals base directory
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
5285d6 |
# structure.
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
5285d6 |
ENTRY=${MANUAL_BASEDIR}/${ENTRY}
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
# Output entry's absolute path.
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
5285d6 |
echo ${ENTRY}
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
4c79b5 |
}
|