[freefoam] 03/09: Remove UserGuide. (Closes: #708877)
Anton Gladky
gladk at moszumanska.debian.org
Thu Sep 18 04:27:29 UTC 2014
This is an automated email from the git hooks/post-receive script.
gladk pushed a commit to branch master
in repository freefoam.
commit 46b30f05694e66abc1f6225d296a6d73b9930876
Author: Anton Gladky <gladk at debian.org>
Date: Wed Sep 17 20:46:17 2014 +0200
Remove UserGuide. (Closes: #708877)
---
debian/README | 1 +
debian/copyright | 7 +-
debian/freefoam-user-doc.doc-base | 9 -
debian/freefoam-user-doc.install | 1 -
.../doxygen-generated-file-names-breakage.diff | 44 +++--
debian/patches/update-doxygen-foamheader.diff | 26 ++-
debian/patches/update-for-removed-apps.diff | 184 ---------------------
7 files changed, 47 insertions(+), 225 deletions(-)
diff --git a/debian/README b/debian/README
index b8e293b..b55360f 100644
--- a/debian/README
+++ b/debian/README
@@ -1,6 +1,7 @@
The following non-free or non-distributable files the following have been removed:
./applications/utilities/surface/surfaceCoarsen/bunnylod/rabdata.h
./applications/utilities/surface/surfaceCoarsen/bunnylod/rabdata.C
+./doc/UserGuide/*
These file are not used.
The userd plugin for Paraview to convert ensight data has been desibled because
diff --git a/debian/copyright b/debian/copyright
index 50ca996..b6ad0ca 100644
--- a/debian/copyright
+++ b/debian/copyright
@@ -2,6 +2,7 @@ Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: FreeFOAM
Upstream-Contact: Michael Wild <themiwi at users.sourceforge.net>
Source: http://freefoam.wiki.sourceforge.net/
+Files-Exclude: doc/UserGuide/*
Files: *.C *.H *.L *.C.in *.c *.h *.unv *.msh *.agr *.gplt *.xy *.geo *.dat
data/templates/foamCommentStyles
@@ -11,12 +12,6 @@ License: GPL-3+
On Debian systems, the full text of the GNU General Public License version 3
can be found in the file '/usr/share/common-licenses/GPL-3'
-Files: doc/UserGuide/*.txt
-Copyright: Copyright (C) 2000-2010 OpenCFD Ltd.
-License: GFDL-NIV-1.2
- On Debian systems, the full text of the GNU Free Documentation License
- version 1.2 can be found in the file '/usr/share/common-licenses/GFDL-1.2'
-
Files:
applications/utilities/surface/surfaceCoarsen/bunnylod/font.h
applications/utilities/surface/surfaceCoarsen/bunnylod/list.h
diff --git a/debian/freefoam-user-doc.doc-base b/debian/freefoam-user-doc.doc-base
deleted file mode 100644
index fd805dc..0000000
--- a/debian/freefoam-user-doc.doc-base
+++ /dev/null
@@ -1,9 +0,0 @@
-Document: freefoam-users-doc
-Title: FreeFOAM users manual
-Author: Open CFD
-Abstract: This manual describes how to use the FreeFOAM software.
-Section: Science/Physics
-
-Format: PDF
-Files:
- /usr/share/doc/freefoam-user-doc/UserGuide.pdf.gz
diff --git a/debian/freefoam-user-doc.install b/debian/freefoam-user-doc.install
index 30d58da..ced5ad4 100644
--- a/debian/freefoam-user-doc.install
+++ b/debian/freefoam-user-doc.install
@@ -1,2 +1 @@
debian/tmp/usr/share/doc/freefoam/tutorials/* /usr/share/doc/freefoam-user-doc/tutorials/
-debian/tmp/usr/share/doc/freefoam/UserGuide.pdf /usr/share/doc/freefoam-user-doc/
diff --git a/debian/patches/doxygen-generated-file-names-breakage.diff b/debian/patches/doxygen-generated-file-names-breakage.diff
index c1af6ab..ee622c9 100644
--- a/debian/patches/doxygen-generated-file-names-breakage.diff
+++ b/debian/patches/doxygen-generated-file-names-breakage.diff
@@ -16,10 +16,10 @@ Signed-off-by: Michael Wild <themiwi at users.sourceforge.net>
CMakeLists.txt | 5 +++++
3 files changed, 12 insertions(+), 1 deletion(-)
-diff --git a/CMake/FOAMUse.cmake.in b/CMake/FOAMUse.cmake.in
-index 8976b90..c54865b 100644
---- a/CMake/FOAMUse.cmake.in
-+++ b/CMake/FOAMUse.cmake.in
+Index: freefoam-0.1.0/CMake/FOAMUse.cmake.in
+===================================================================
+--- freefoam-0.1.0.orig/CMake/FOAMUse.cmake.in
++++ freefoam-0.1.0/CMake/FOAMUse.cmake.in
@@ -259,6 +259,9 @@
# DO NOT call this function after you called FOAM_WRITE_DOC_INDEX(), it won't
# have any effect!
@@ -30,11 +30,11 @@ index 8976b90..c54865b 100644
# FOAM_WRITE_DOC_INDEX()
#
# Create the documentation index file. Call this function after all calls to
-diff --git a/CMake/FOAMUtilities.cmake b/CMake/FOAMUtilities.cmake
-index ba6cc0b..26eb41b 100644
---- a/CMake/FOAMUtilities.cmake
-+++ b/CMake/FOAMUtilities.cmake
-@@ -582,7 +582,10 @@ unset(__FOAM_ADD_EXECUTABLE_TO_DOC_INDEX_targets CACHE)
+Index: freefoam-0.1.0/CMake/FOAMUtilities.cmake
+===================================================================
+--- freefoam-0.1.0.orig/CMake/FOAMUtilities.cmake
++++ freefoam-0.1.0/CMake/FOAMUtilities.cmake
+@@ -582,7 +582,10 @@ unset(__FOAM_ADD_EXECUTABLE_TO_DOC_INDEX
function(foam_add_executable_to_doc_index target source)
get_filename_component(f ${source} NAME_WE)
@@ -46,11 +46,11 @@ index ba6cc0b..26eb41b 100644
set(__FOAM_ADD_EXECUTABLE_TO_DOC_INDEX_targets
${__FOAM_ADD_EXECUTABLE_TO_DOC_INDEX_targets} "${target} (${files})"
CACHE INTERNAL "Files to include in the documentation index"
-diff --git a/CMakeLists.txt b/CMakeLists.txt
-index 88551db..e821cdb 100644
---- a/CMakeLists.txt
-+++ b/CMakeLists.txt
-@@ -252,6 +252,11 @@ if(FOAM_ENABLE_DOXYGEN_DOCS)
+Index: freefoam-0.1.0/CMakeLists.txt
+===================================================================
+--- freefoam-0.1.0.orig/CMakeLists.txt
++++ freefoam-0.1.0/CMakeLists.txt
+@@ -255,6 +255,11 @@ if(FOAM_ENABLE_DOXYGEN_DOCS)
"Versions newer than 1.6.3 and older than 1.7.2-20101106 "
"usually crash when processing the ${PROJECT_NAME} documentation.")
endif()
@@ -62,6 +62,16 @@ index 88551db..e821cdb 100644
# ask user whether she prefers local or www docs
foam_option(FOAM_USE_LOCAL_DOXYGEN_DOCS "Use local API docs"
"Use the local API documentation instead of http://freefoam.sf.net/doc/API"
---
-1.7.9.5
-
+Index: freefoam-0.1.0/doc/CMakeLists.txt
+===================================================================
+--- freefoam-0.1.0.orig/doc/CMakeLists.txt
++++ freefoam-0.1.0/doc/CMakeLists.txt
+@@ -144,8 +144,4 @@ if(FOAM_ENABLE_XHTML_GUIDES AND FOAM_ENA
+ DESTINATION "${FOAM_INSTALL_DOC_PATH}/js" COMPONENT doc)
+ endif()
+
+-if(FOAM_GUIDES_FORMATS)
+- add_subdirectory(UserGuide)
+-endif()
+-
+ # ------------------------- vim: set sw=2 sts=2 et: --------------- end-of-file
diff --git a/debian/patches/update-doxygen-foamheader.diff b/debian/patches/update-doxygen-foamheader.diff
index fd35b8b..e32b51d 100644
--- a/debian/patches/update-doxygen-foamheader.diff
+++ b/debian/patches/update-doxygen-foamheader.diff
@@ -9,10 +9,10 @@ Signed-off-by: Michael Wild <themiwi at users.sourceforge.net>
doc/Doxygen/FoamHeader.html.in | 20 ++++++++++++--------
1 file changed, 12 insertions(+), 8 deletions(-)
-diff --git a/doc/Doxygen/FoamHeader.html.in b/doc/Doxygen/FoamHeader.html.in
-index efa5b93..322d605 100644
---- a/doc/Doxygen/FoamHeader.html.in
-+++ b/doc/Doxygen/FoamHeader.html.in
+Index: freefoam-0.1.0+dfsg/doc/Doxygen/FoamHeader.html.in
+===================================================================
+--- freefoam-0.1.0+dfsg.orig/doc/Doxygen/FoamHeader.html.in
++++ freefoam-0.1.0+dfsg/doc/Doxygen/FoamHeader.html.in
@@ -3,17 +3,20 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
@@ -42,11 +42,21 @@ index efa5b93..322d605 100644
<title>FreeFOAM programmer's C++ documentation</title>
</head>
<body>
-@@ -62,3 +65,4 @@
+@@ -50,15 +53,12 @@
+ </div>
+ @FOAM_DOXYDOC_FOR_SF_BEGIN@
+ <div id="layout-sf">
+- Hosted by SourceForge:<br />
+ <a href="http://sourceforge.net/projects/freefoam">
+- <img
+- src="http://sflogo.sourceforge.net/sflogo.php?group_id=215833&type=12"
+- width="120" height="30" alt="Get FreeFOAM at SourceForge.net.
+- Fast, secure and Free Open Source software downloads" />
++ Hosted by SourceForge:<br />
+ </a>
+ </div>
+ @FOAM_DOXYDOC_FOR_SF_END@
</div>
<div id="layout-content-box">
<div id="layout-content">
+ <div id="top"> <!-- closed by doxygen! -->
---
-1.7.9.5
-
diff --git a/debian/patches/update-for-removed-apps.diff b/debian/patches/update-for-removed-apps.diff
index c1abcfa..c329b69 100644
--- a/debian/patches/update-for-removed-apps.diff
+++ b/debian/patches/update-for-removed-apps.diff
@@ -8,14 +8,8 @@ Signed-off-by: Michael Wild <themiwi at users.sourceforge.net>
INSTALL | 4 +-
data/shellFunctions/bashCompletion/freefoam | 2 +-
data/shellFunctions/zshCompletion/_freefoam | 8 +--
- doc/UserGuide/applications/utilities.txt | 6 --
- doc/UserGuide/files.cmake | 1 -
- doc/UserGuide/postProcessing/ensight.txt | 74 +--------------------
- doc/UserGuide/postProcessing/fieldview.txt | 26 --------
- doc/UserGuide/postProcessing/index.txt | 5 +-
tutorials/basic/laplacianFoam/flange/Allrun.py.in | 2 -
9 files changed, 6 insertions(+), 122 deletions(-)
- delete mode 100644 doc/UserGuide/postProcessing/fieldview.txt
diff --git a/INSTALL b/INSTALL
index d3cce22..96374ef 100644
@@ -78,184 +72,6 @@ index a3f1f16..f8f3169 100644
# apps taking -dict, all time and common options.
_freefoam-common_time_dict_apps() {
_arguments -S \
-diff --git a/doc/UserGuide/applications/utilities.txt b/doc/UserGuide/applications/utilities.txt
-index 50490f2..3330c4f 100644
---- a/doc/UserGuide/applications/utilities.txt
-+++ b/doc/UserGuide/applications/utilities.txt
-@@ -194,9 +194,6 @@ cells in relation to surface
- split cells with flat faces
-
- 2+h| Post-processing graphics
--| `ensightFoamReader`(((`ensightFoamReader` utility)))
--(((utility,`ensightFoamReader`))) | 'EnSight' library module to read {project}
--data directly without translation
- | `fieldview9Reader`(((`fieldview9Reader` utility)))
- (((utility,`fieldview9Reader`))) | Reader module for 'Fieldview' 9 to read
- {project} mesh and data
-@@ -209,9 +206,6 @@ Translates {project} data to 'EnSight' format
- | `foamToEnsightParts`(((`foamToEnsightParts` utility)))
- (((utility,`foamToEnsightParts`))) | Translates {project} data to 'Ensight'
- format. An Ensight part is created for each `cellZone` and patch
--| `foamToFieldview9`(((`foamToFieldview9` utility)))
--(((utility,`foamToFieldview9`))) | Write out the {project} mesh in Version 3.0
--'Fieldview'-UNS format (binary)
- | `foamToGMV`(((`foamToGMV` utility)))(((utility,`foamToGMV`))) | Translates
- foam output to 'GMV' readable files
- | `foamToVTK`(((`foamToVTK` utility)))(((utility,`foamToVTK`))) | Legacy 'VTK'
-diff --git a/doc/UserGuide/files.cmake b/doc/UserGuide/files.cmake
-index 4efe7a3..d5117b8 100644
---- a/doc/UserGuide/files.cmake
-+++ b/doc/UserGuide/files.cmake
-@@ -62,7 +62,6 @@ set(ASCIIDOC_SRCS
- postProcessing/index.txt
- postProcessing/para.txt
- postProcessing/fluent.txt
-- postProcessing/fieldview.txt
- postProcessing/ensight.txt
- postProcessing/sample.txt
- postProcessing/monitoring.txt
-diff --git a/doc/UserGuide/postProcessing/ensight.txt b/doc/UserGuide/postProcessing/ensight.txt
-index 5e441ee..4a921f1 100644
---- a/doc/UserGuide/postProcessing/ensight.txt
-+++ b/doc/UserGuide/postProcessing/ensight.txt
-@@ -1,12 +1,8 @@
- === Post-processing with 'EnSight'
-
- {project} offers the capability for post-processing {project} cases with
--'EnSight', with a choice of 2 options:
--
--- converting the {project} data to 'EnSight' format with the `foamToEnsight`
-- utility;
--- reading the {project} data directly into 'EnSight' using the
-- `ensight74FoamExec` module.
-+'EnSight' by converting the {project} data to 'EnSight' format with the
-+`foamToEnsight` utility.
-
- ==== Converting data to 'EnSight' format
-
-@@ -31,69 +27,3 @@ normal means:
- . the guilabel:[Format] selector should be set to guilabel:[Case], the
- 'EnSight' default setting;
- . the user should click guibutton:[(Set) Case] and guibutton:[Okay].
--
--==== The `ensight74FoamExec` reader module
--
--'EnSight' provides the capability of using a user-defined module to read data
--from a format other than the standard 'EnSight' format. {project} includes its
--own reader module `ensight74FoamExec`(((`ensight74FoamExec` utility)))
--(((utility,`ensight74FoamExec`))) that is compiled into a library named
--filename:userd[]. It is this library that 'EnSight' needs to use which means
--that it must be able to locate it on the filing system as described in the
--following section.
--
--===== Configuration of 'EnSight' for the reader module
--
--In order to run the 'EnSight' reader, it is necessary to set some environment
--variables correctly. The environment variables associated with 'EnSight' are
--prefixed by `$CEI_` or `$ENSIGHT7_` and listed in <<tab_ensightEnvVariables>>.
--With a standard user setup, only `$CEI_HOME` may need to be set manually, to
--the path of the 'EnSight' installation.
--
--[[tab_ensightEnvVariables]]
--.Environment variable settings for 'EnSight'
--[grid="none",frame="topbot",options="header"]
--|==============================================================================
--| Environment variable | Description and options
--| `$CEI_HOME`(((`CEI_HOME`,environment variable)))
--(((environment variable,`CEI_HOME`))) | Path where 'EnSight' is installed,
--'e.g.' filename:/usr/local/ensight[], added to the system path by default
--| `$CEI_ARCH`(((`CEI_ARCH`,environment variable)))
--(((environment variable,`CEI_ARCH`))) | Machine architecture, from a choice of
--names corresponding to the machine directory names in
--filename:$CEI_HOME/ensight74/machines[]; default settings include `linux_2.4`
--and `sgi_6.5`
--| `$ENSIGHT7_READER`(((`ENSIGHT7_READER`,environment variable)))
--(((environment variable,`ENSIGHT7_READER`))) | Path that 'EnSight' searches for
--the user defined filename:userd[] reader library
--| `$ENSIGHT7_INPUT`(((`ENSIGHT7_INPUT`,environment variable)))
--(((environment variable,`ENSIGHT7_INPUT`))) | Set by default to `dummy`
--|==============================================================================
--
--===== Using the reader module
--
--The principal difficulty in using the 'EnSight' reader lies in the fact that
--'EnSight' expects that a case to be defined by the contents of a particular
--file, rather than a directory as it is in {project}. Therefore in following the
--instructions for the using the reader below, the user should pay particular
--attention to the details of case selection, since 'EnSight' does not permit
--selection of a directory name.
--
--. from the 'EnSight' GUI, the user should select
-- menuselection:[File --> Data (Reader)];
--. The user should now be able to select the ++{project}++ from the
-- guilabel:[Format] menu; if not, there is a problem with the configuration
-- described above.
--. The user should find their case directory from the guilabel:[File Selection]
-- window, highlight one of top 2 entries in the guilabel:[Directories] box
-- ending in dirname:/.[] or dirname:/..[] and click guibutton:[(Set) Geometry].
--. The path field should now contain an entry for the case.
-- The guilabel:[(Set) Geometry] text box should contain a `+/+'.
--. The user may now click guibutton:[Okay] and 'EnSight' will begin reading the
-- data.
--. When the data is read, a new guilabel:[Data Part Loader] window will appear,
-- asking which part(s) are to be read. The user should select
-- guilabel:[Load all].
--. When the mesh is displayed in the 'EnSight' window the user should close the
-- guilabel:[Data Part Loader] window, since some features of 'EnSight' will not
-- work with this window open.
-diff --git a/doc/UserGuide/postProcessing/fieldview.txt b/doc/UserGuide/postProcessing/fieldview.txt
-deleted file mode 100644
-index a5513c3..0000000
---- a/doc/UserGuide/postProcessing/fieldview.txt
-+++ /dev/null
-@@ -1,26 +0,0 @@
--=== Post-processing with 'Fieldview'
--
--{project} offers the capability for post-processing {project} cases with
--'Fieldview'. The method involves running a post-processing utility
--`foamToFieldview` to convert case data from {project} to 'Fieldview'
--filename:.uns[] file format. For a given case, `foamToFieldview` is executed
--like any normal application. `foamToFieldview` creates a directory named
--dirname:Fieldview[] in the case directory, 'deleting any existing'
--dirname:Fieldview[] 'directory in the process'. By default the converter reads
--the data in all time directories and writes into a set of files of the form
--filename:<case>_<nn>.uns[], where '<nn>' is an incremental counter starting
--from 1 for the first time directory, 2 for the second and so on. The user may
--specify the conversion of a single time directory with the option
--`-time <time>`, where '<time>' is a time in general, scientific or fixed
--format.
--
--'Fieldview' provides certain functions that require information about boundary
--conditions, 'e.g.' drawing streamlines that uses information about wall
--boundaries. The converter tries, wherever possible, to include this information
--in the converted files by default. The user can disable the inclusion of this
--information by using the option:-noWall[] option in the execution command.
--
--The data files for 'Fieldview' have the filename:.uns[] extension as mentioned
--already. If the original {project} case includes a dot `.', 'Fieldview' may
--have problems interpreting a set of data files as a single case with multiple
--time steps.
-diff --git a/doc/UserGuide/postProcessing/index.txt b/doc/UserGuide/postProcessing/index.txt
-index 59f70ec..c886574 100644
---- a/doc/UserGuide/postProcessing/index.txt
-+++ b/doc/UserGuide/postProcessing/index.txt
-@@ -7,15 +7,12 @@ supplied with a post-processing utility `para` that uses 'ParaView', an open
- source visualisation application described in <<sec_paraFoam>>.
-
- Other methods of post-processing using third party products are offered,
--including 'EnSight', 'Fieldview' and the post-processing supplied with
--'Fluent'.
-+including 'EnSight', and the post-processing supplied with 'Fluent'.
-
- include::para.txt[]
-
- include::fluent.txt[]
-
--include::fieldview.txt[]
--
- include::ensight.txt[]
-
- include::sample.txt[]
diff --git a/tutorials/basic/laplacianFoam/flange/Allrun.py.in b/tutorials/basic/laplacianFoam/flange/Allrun.py.in
index f3ba02a..312da08 100755
--- a/tutorials/basic/laplacianFoam/flange/Allrun.py.in
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/freefoam.git
More information about the debian-science-commits
mailing list