Request for Changes-27: Merge Software Guide into OTB
From OTBWiki
Contents
Status
- Author: Victor Poughon
- Submitted on 17.02.2016
- Proposed target release 5.4
- Adopted (if voted for), Rejected (if voted against), Merged in OTB x.y (if merged)
- https://git.orfeo-toolbox.org/otb.git/shortlog/refs/heads/software_guide
Summary
Move the Software Guide to OTB tree to deal with git branches synchronization issues.
Rationale
Currently, the SoftwareGuide lives in the otb-documents repository. This repository does not follow the OTB git workflow. This is an issue now that work can happen simultaneously on release and develop branches. The software guide is a release deliverable that is built nightly. De-synchronization of otb-documents and otb main repository is a problem if documentation content is incorrect (version numbers is the best exemple) or if the OTB api changes for compiling the software guide. Additionally, otb-documents also contains:
Artwork Courses CourseWare Doxygen IDLBindings Monteverdi2 PSC Publications Slides
which are not deliverables and it makes sense to have them in a seperate repository with only a single master branch.
This would have the additional benefit of allowing documentation contributions in a feature branch.
Related JIRA issues: OTB-951, OTB-412.
Implementation details
Classes and files
See below for modified files.
Preserving the git history would be nice (like we did for ice as a module). However the otb-documents repository contains a lot of things and we only want to bring in the SoftwareGuide's history. So we have to choose between:
1. Only use add a copy of the SoftwareGuide. Lose history. (it's still in otb-documents). Adds 31MB.
2. Create a branch in otb-documents, "git rm" everything except the SoftwareGuide folder and merge that into OTB. We end up with the entire history for the Cookbook (the old one in latex), the Artwork in .png... etc. Adds 825 MB.
This RFC implements 1. The content is copied from commit 8598cb5b6af4c53824b6c65ea53e79c8aec051b0.
Applications
NA
Tests
NA
Documentation
Content is unchanged.
Additional notes
Modified files:
A Documentation/Latex/Copyright.tex A Documentation/Latex/HowtoExample.tex A Documentation/Latex/Insight.bib A Documentation/Latex/Insight.ist A Documentation/Latex/Insight.sty A Documentation/Latex/InsightBook.cls A Documentation/Latex/InsightHowto.cls A Documentation/Latex/InsightManual.cls A Documentation/Latex/InsightMarkup.sty A Documentation/Latex/InsightPaper.sty A Documentation/Latex/InsightSoftwareGuide.cls A Documentation/Latex/License.tex A Documentation/Latex/algorithm.sty A Documentation/Latex/algorithmic.sty A Documentation/Latex/amssymb.sty A Documentation/Latex/doubleWordCheck.pl A Documentation/Latex/extractImageBoundingBox.sh A Documentation/Latex/fancyhdr.sty A Documentation/Latex/floatflt.sty A Documentation/Latex/fncychap.sty A Documentation/Latex/listings.sty A Documentation/Latex/picins.sty A Documentation/Latex/times.sty A Documentation/SoftwareGuide/Art/Anomaly_Detection_Workflow.eps A Documentation/SoftwareGuide/Art/Anomaly_HYP.eps A Documentation/SoftwareGuide/Art/BayesianPluginClassifier.fig A Documentation/SoftwareGuide/Art/BinaryThresholdTransferFunction.fig A Documentation/SoftwareGuide/Art/CMakeLists.txt A Documentation/SoftwareGuide/Art/CMakeSetupScreenShot.jpg A Documentation/SoftwareGuide/Art/CNES_nom.eps A Documentation/SoftwareGuide/Art/CNES_nom.png A Documentation/SoftwareGuide/Art/CompareImages.tcl A Documentation/SoftwareGuide/Art/CompositeExamplePipeline.fig A Documentation/SoftwareGuide/Art/CompositeFilterStages.fig A Documentation/SoftwareGuide/Art/Cube_HPX.eps A Documentation/SoftwareGuide/Art/DataPipeline.fig A Documentation/SoftwareGuide/Art/DataPipelineOneConnection.fig A Documentation/SoftwareGuide/Art/DataPipelineUpdate.fig A Documentation/SoftwareGuide/Art/Decomposition_MML_HPX.eps A Documentation/SoftwareGuide/Art/DiscreteGaussian.fig A Documentation/SoftwareGuide/Art/DiscreteGaussian.gnu A Documentation/SoftwareGuide/Art/DisplayImage.tcl A Documentation/SoftwareGuide/Art/DudaClassifier.fig A Documentation/SoftwareGuide/Art/FastMarchingCollaborationDiagram1.fig A Documentation/SoftwareGuide/Art/FuzzyConnectednessClassDiagram1.fig A Documentation/SoftwareGuide/Art/FuzzyConnectednessCollaborationDiagram1.fig A Documentation/SoftwareGuide/Art/FuzzyVoronoiCollaborationDiagram1.fig A Documentation/SoftwareGuide/Art/FuzzyVoronoiDeformableCollaborationDiagram1.fig A Documentation/SoftwareGuide/Art/GeometricalObjects.eps A Documentation/SoftwareGuide/Art/GeometricalObjects.fig A Documentation/SoftwareGuide/Art/HybridSegmentationEngine1.fig A Documentation/SoftwareGuide/Art/ImageAdaptorConcept.fig A Documentation/SoftwareGuide/Art/ImageIOCollaborationDiagram.fig A Documentation/SoftwareGuide/Art/ImageIOFactoriesClassDiagram.fig A Documentation/SoftwareGuide/Art/ImageIOFactoriesUseCases.fig A Documentation/SoftwareGuide/Art/ImageOriginAndSpacing.fig A Documentation/SoftwareGuide/Art/ImageOverlapInterpolator.fig A Documentation/SoftwareGuide/Art/ImageOverlapIterator.fig A Documentation/SoftwareGuide/Art/ImageRegistration1Figures.gnup A Documentation/SoftwareGuide/Art/ImageRegistration1Pipeline.fig A Documentation/SoftwareGuide/Art/ImageRegistration1TraceMetric.eps A Documentation/SoftwareGuide/Art/ImageRegistration1TraceTranslations.eps A Documentation/SoftwareGuide/Art/ImageRegistrationConcept.fig A Documentation/SoftwareGuide/Art/ImageRegistrationCoordinateSystemsDiagram.fig A Documentation/SoftwareGuide/Art/IteratorFigure1.fig A Documentation/SoftwareGuide/Art/Kitware-logo-medium-res.jpg A Documentation/SoftwareGuide/Art/LevelSetSegmentationFigure1.fig A Documentation/SoftwareGuide/Art/LevelSetZeroSet.fig A Documentation/SoftwareGuide/Art/Linear_Unmixing_HPX.eps A Documentation/SoftwareGuide/Art/MarkovFramework.eps A Documentation/SoftwareGuide/Art/NeighborhoodIteratorFig1.fig A Documentation/SoftwareGuide/Art/NeighborhoodIteratorFig2.fig A Documentation/SoftwareGuide/Art/OptimizersHierarchy.eps A Documentation/SoftwareGuide/Art/OptimizersHierarchy.fig A Documentation/SoftwareGuide/Art/ParzenWindowing1.fig A Documentation/SoftwareGuide/Art/ParzenWindowing13.eps A Documentation/SoftwareGuide/Art/ParzenWindowing13.fig A Documentation/SoftwareGuide/Art/ParzenWindowing2.fig A Documentation/SoftwareGuide/Art/ParzenWindowing3.fig A Documentation/SoftwareGuide/Art/PointSetWithVectors.fig A Documentation/SoftwareGuide/Art/RegistrationComponentsDiagram.fig A Documentation/SoftwareGuide/Art/RoadExtractionSpectralAngleDiagram.eps A Documentation/SoftwareGuide/Art/Simplex_HPX.eps A Documentation/SoftwareGuide/Art/Sliding_Window_Anomaly_Algo.eps A Documentation/SoftwareGuide/Art/StatisticalClassificationFramework.fig A Documentation/SoftwareGuide/Art/ThresholdTransferFunctionAbove.fig A Documentation/SoftwareGuide/Art/ThresholdTransferFunctionBelow.fig A Documentation/SoftwareGuide/Art/ThresholdTransferFunctionOutside.fig A Documentation/SoftwareGuide/Art/TransformsHierarchy.dot A Documentation/SoftwareGuide/Art/TwoNormalDensityFunctionPlot.jpg A Documentation/SoftwareGuide/Art/VisualizationAll.jpg A Documentation/SoftwareGuide/Art/VoronoiSegmentationClassDiagram1.fig A Documentation/SoftwareGuide/Art/VoronoiSegmentationCollaborationDiagram1.fig A Documentation/SoftwareGuide/Art/VoronoiSegmentationCollaborationDiagram2.fig A Documentation/SoftwareGuide/Art/WatershedCatchmentBasins.fig A Documentation/SoftwareGuide/Art/WatershedImageFilter.fig A Documentation/SoftwareGuide/Art/WatershedsHierarchy.fig A Documentation/SoftwareGuide/Art/carte.eps A Documentation/SoftwareGuide/Art/carte.fig A Documentation/SoftwareGuide/Art/ccmakeScreenShot.jpg A Documentation/SoftwareGuide/Art/itkLogo.jpg A Documentation/SoftwareGuide/Art/logoVectoriel.eps A Documentation/SoftwareGuide/Art/otb1.jpg A Documentation/SoftwareGuide/Art/otb2.jpg A Documentation/SoftwareGuide/Art/pleiade.jpg A Documentation/SoftwareGuide/Art/zones.eps A Documentation/SoftwareGuide/CMakeLists.txt A Documentation/SoftwareGuide/CTestConfig.cmake A Documentation/SoftwareGuide/Cover/README.txt A Documentation/SoftwareGuide/Cover/Source/AntialiasFilter.cxx A Documentation/SoftwareGuide/Cover/Source/BinaryMaskMedianFilter.cxx A Documentation/SoftwareGuide/Cover/Source/BinaryThresholdFilter.cxx A Documentation/SoftwareGuide/Cover/Source/CMakeLists.txt A Documentation/SoftwareGuide/Cover/Source/DilateFilter.cxx A Documentation/SoftwareGuide/Cover/Source/ImageReadExtractWriteRGB.cxx A Documentation/SoftwareGuide/Cover/Source/ModelBasedSegmentation.cxx A Documentation/SoftwareGuide/Cover/Source/NegateFilter.cxx A Documentation/SoftwareGuide/Cover/Source/RescaleIntensityFilter.cxx A Documentation/SoftwareGuide/Cover/Source/SoftwareGuideCover.tcl A Documentation/SoftwareGuide/Cover/Source/VWBlueRemoval.cxx A Documentation/SoftwareGuide/Cover/Source/VWColorSegmentation.cxx A Documentation/SoftwareGuide/Cover/Source/VWHistogramHSV.cxx A Documentation/SoftwareGuide/Cover/Source/VWHistogramRGB.cxx A Documentation/SoftwareGuide/Cover/Source/VectorGradientAnisotropicDiffusionFilter.cxx A Documentation/SoftwareGuide/Cover/Source/seedPoints A Documentation/SoftwareGuide/DvipsWrapper.bat.in A Documentation/SoftwareGuide/DvipsWrapper.sh.in A Documentation/SoftwareGuide/Examples/CMakeLists.txt A Documentation/SoftwareGuide/Examples/RunExamples.pl A Documentation/SoftwareGuide/Examples/Test.cxx A Documentation/SoftwareGuide/LaTeXWrapper.bat.in A Documentation/SoftwareGuide/LaTeXWrapper.sh.in A Documentation/SoftwareGuide/Latex/Abstract.tex A Documentation/SoftwareGuide/Latex/AnisotropicDiffusionFiltering.tex A Documentation/SoftwareGuide/Latex/Applications.tex A Documentation/SoftwareGuide/Latex/CMakeLists.txt A Documentation/SoftwareGuide/Latex/ChangeDetection.tex A Documentation/SoftwareGuide/Latex/Classification.tex A Documentation/SoftwareGuide/Latex/CompilingMonteverdi.tex A Documentation/SoftwareGuide/Latex/Contribute.tex A Documentation/SoftwareGuide/Latex/ContributorList.txt A Documentation/SoftwareGuide/Latex/ContributorListRandom.tex A Documentation/SoftwareGuide/Latex/Contributors.tex A Documentation/SoftwareGuide/Latex/Cover.tex A Documentation/SoftwareGuide/Latex/DataRepresentation.tex A Documentation/SoftwareGuide/Latex/DimensionReduction.tex A Documentation/SoftwareGuide/Latex/DisparityEstimation.tex A Documentation/SoftwareGuide/Latex/FAQ.tex A Documentation/SoftwareGuide/Latex/FeatureExtraction.tex A Documentation/SoftwareGuide/Latex/Filtering.tex A Documentation/SoftwareGuide/Latex/FiniteElementRegistrationParameters1.txt A Documentation/SoftwareGuide/Latex/Fusion.tex A Documentation/SoftwareGuide/Latex/GUI.tex A Documentation/SoftwareGuide/Latex/HybridSegmentationMethods.tex A Documentation/SoftwareGuide/Latex/Hyperspectral.tex A Documentation/SoftwareGuide/Latex/Hyperspectral.txt A Documentation/SoftwareGuide/Latex/Hyperspectral_tr.txt A Documentation/SoftwareGuide/Latex/IDLBindings.tex A Documentation/SoftwareGuide/Latex/IO.tex A Documentation/SoftwareGuide/Latex/ImageAdaptors.tex A Documentation/SoftwareGuide/Latex/ImageInterpolators.tex A Documentation/SoftwareGuide/Latex/ImageMetrics.tex A Documentation/SoftwareGuide/Latex/ImageRegistration.tex A Documentation/SoftwareGuide/Latex/ImageSegmentation.tex A Documentation/SoftwareGuide/Latex/ImageSimulation.tex A Documentation/SoftwareGuide/Latex/Infrastructure.tex A Documentation/SoftwareGuide/Latex/Installation.tex A Documentation/SoftwareGuide/Latex/Introduction.tex A Documentation/SoftwareGuide/Latex/Iterators.tex A Documentation/SoftwareGuide/Latex/Kohonen.tex A Documentation/SoftwareGuide/Latex/LevelSetsSegmentation.tex A Documentation/SoftwareGuide/Latex/MultiScaleAnalysis.tex A Documentation/SoftwareGuide/Latex/Numerics.tex A Documentation/SoftwareGuide/Latex/OTB-FAQ.tex A Documentation/SoftwareGuide/Latex/ObjectBasedImageAnalysis.tex A Documentation/SoftwareGuide/Latex/Online.tex A Documentation/SoftwareGuide/Latex/Optimizers.tex A Documentation/SoftwareGuide/Latex/OrthoRectification.tex A Documentation/SoftwareGuide/Latex/Persistent.tex A Documentation/SoftwareGuide/Latex/PrintedPreamble.tex A Documentation/SoftwareGuide/Latex/README.txt A Documentation/SoftwareGuide/Latex/RELEASE_NOTES.txt A Documentation/SoftwareGuide/Latex/Radiometry.tex A Documentation/SoftwareGuide/Latex/ReadWrite.tex A Documentation/SoftwareGuide/Latex/ReadWriteVectorData.tex A Documentation/SoftwareGuide/Latex/Registration.tex A Documentation/SoftwareGuide/Latex/ReleaseNotes.tex A Documentation/SoftwareGuide/Latex/Segmentation.tex A Documentation/SoftwareGuide/Latex/SoftwareGuide.tex A Documentation/SoftwareGuide/Latex/SoftwareProcess.tex A Documentation/SoftwareGuide/Latex/SpatialObjects.tex A Documentation/SoftwareGuide/Latex/Statistics.tex A Documentation/SoftwareGuide/Latex/StereoReconstruction.tex A Documentation/SoftwareGuide/Latex/StreamingAndThreading.tex A Documentation/SoftwareGuide/Latex/SystemOverview.tex A Documentation/SoftwareGuide/Latex/Transforms.tex A Documentation/SoftwareGuide/Latex/Tutorial.tex A Documentation/SoftwareGuide/Latex/Visualization.tex A Documentation/SoftwareGuide/Latex/Watersheds.tex A Documentation/SoftwareGuide/Latex/Wrapping.tex A Documentation/SoftwareGuide/Latex/WriteACompositeFilter.tex A Documentation/SoftwareGuide/Latex/WriteAFilter.tex A Documentation/SoftwareGuide/Latex/WriteAnApplication.tex A Documentation/SoftwareGuide/Latex/WriteModules.tex A Documentation/SoftwareGuide/Latex/generateRandomContributorList.py A Documentation/SoftwareGuide/ParseCxxExamples.pl A Documentation/SoftwareGuide/SoftwareGuideConfiguration.tex.in A Documentation/SoftwareGuide/StripCxxExamples.pl A Documentation/SoftwareGuide/Tex4htWrapper.sh.in A Documentation/SoftwareGuide/generate_FAQ.sh.in
