Changeset c307ba

Timestamp:

Aug 5, 2015, 7:12:24 AM (9 years ago)

Author:

Frederik Heber <heber@…>

Branches:

Action_Thermostats, Add_AtomRandomPerturbation, Add_FitFragmentPartialChargesAction, Add_RotateAroundBondAction, Add_SelectAtomByNameAction, Added_ParseSaveFragmentResults, AddingActions_SaveParseParticleParameters, Adding_Graph_to_ChangeBondActions, Adding_MD_integration_tests, Adding_ParticleName_to_Atom, Adding_StructOpt_integration_tests, AtomFragments, Automaking_mpqc_open, AutomationFragmentation_failures, Candidate_v1.5.4, Candidate_v1.6.0, Candidate_v1.6.1, ChangeBugEmailaddress, ChangingTestPorts, ChemicalSpaceEvaluator, CombiningParticlePotentialParsing, Combining_Subpackages, Debian_Package_split, Debian_package_split_molecuildergui_only, Disabling_MemDebug, Docu_Python_wait, EmpiricalPotential_contain_HomologyGraph, EmpiricalPotential_contain_HomologyGraph_documentation, Enable_parallel_make_install, Enhance_userguide, Enhanced_StructuralOptimization, Enhanced_StructuralOptimization_continued, Example_ManyWaysToTranslateAtom, Exclude_Hydrogens_annealWithBondGraph, FitPartialCharges_GlobalError, Fix_BoundInBox_CenterInBox_MoleculeActions, Fix_ChargeSampling_PBC, Fix_ChronosMutex, Fix_FitPartialCharges, Fix_FitPotential_needs_atomicnumbers, Fix_ForceAnnealing, Fix_IndependentFragmentGrids, Fix_ParseParticles, Fix_ParseParticles_split_forward_backward_Actions, Fix_PopActions, Fix_QtFragmentList_sorted_selection, Fix_Restrictedkeyset_FragmentMolecule, Fix_StatusMsg, Fix_StepWorldTime_single_argument, Fix_Verbose_Codepatterns, Fix_fitting_potentials, Fixes, ForceAnnealing_goodresults, ForceAnnealing_oldresults, ForceAnnealing_tocheck, ForceAnnealing_with_BondGraph, ForceAnnealing_with_BondGraph_continued, ForceAnnealing_with_BondGraph_continued_betteresults, ForceAnnealing_with_BondGraph_contraction-expansion, FragmentAction_writes_AtomFragments, FragmentMolecule_checks_bonddegrees, GeometryObjects, Gui_Fixes, Gui_displays_atomic_force_velocity, ImplicitCharges, IndependentFragmentGrids, IndependentFragmentGrids_IndividualZeroInstances, IndependentFragmentGrids_IntegrationTest, IndependentFragmentGrids_Sole_NN_Calculation, JobMarket_RobustOnKillsSegFaults, JobMarket_StableWorkerPool, JobMarket_unresolvable_hostname_fix, MoreRobust_FragmentAutomation, ODR_violation_mpqc_open, PartialCharges_OrthogonalSummation, PdbParser_setsAtomName, PythonUI_with_named_parameters, QtGui_reactivate_TimeChanged_changes, Recreated_GuiChecks, Rewrite_FitPartialCharges, RotateToPrincipalAxisSystem_UndoRedo, SaturateAtoms_findBestMatching, SaturateAtoms_singleDegree, StoppableMakroAction, Subpackage_CodePatterns, Subpackage_JobMarket, Subpackage_LinearAlgebra, Subpackage_levmar, Subpackage_mpqc_open, Subpackage_vmg, Switchable_LogView, ThirdParty_MPQC_rebuilt_buildsystem, TrajectoryDependenant_MaxOrder, TremoloParser_IncreasedPrecision, TremoloParser_MultipleTimesteps, TremoloParser_setsAtomName, Ubuntu_1604_changes, stable

Children:

0ea4dd

Parents:

10aee4

git-author:

Frederik Heber <heber@…> (08/02/15 12:01:05)

git-committer:

Frederik Heber <heber@…> (08/05/15 07:12:24)

Message:

DOCU: Enhanced description of test policy on version update.

File:

• src/documentation/tests/tests.dox (modified) (2 diffs)

src/documentation/tests/tests.dox

@@ -56 +56 @@
  * \section tests-policy Policy on launching tests
  *
- * Note that the above run of \e all \e tests \e should \e pass for each and
- * every single test for each and every single commit in the code history before
- * it is pushed to the central repository (git has ample means via \a rebase for
- * correcting later found errors), both for --disable-debug and --enable-debug.
+ * We have the the following list of checks on every new version:
+ *
+ * -# make check on every commit between old and new version in history
+ *    for both --enable-debug and --disable-debug
+ * -# make distcheck on last version (where version is updated)
+ * -# make check with --enable-valgrind on last version
+ * -# make check on last version with every possible --enable/--disable 
+ *    combination (excluding ecut, valgrind)
+ * 
+ * \subsection tests-policy-check make check
+ *
+ * Note that the call
+ * \code make check \endcode
+ * should \e pass for \e each \e and \e every \a single \e test for each and 
+ * every single commit in the code history before it is pushed to the central
+ * repository (git has ample means via \a rebase for correcting later found
+ * errors), both for \a --disable-debug and \a --enable-debug.
+ *
+ * \subsection tests-policy-distcheck make distcheck
  *
  * Before a version tag is given (e.g. v1.1.3) it is to be made sure that also
@@ -65 +80 @@
  * runs fine and produces a distributable archive.
  *
+ * \subsection tests-policy-enablevalgrind make check with --enable-valgrind
+ *
  * Since v1.4.8 valgrind's memcheck tool runs through as well (on all regression
- * tests). There are three glitches, namely regression tests 28-30 which load
- * python scripts and cause many PyObject_Free and other errors. These are
+ * tests) on make check if configure has been executed with
+ * \code ./configure .. -enable-valgrind \endcode
+ * There are three glitches, namely regression tests 28-30 which load
+ * python scripts and cause many \a PyObject_Free and other errors. These are
  * ignored. A python suppression file was tried but to no success.
- * Similarly, a valgrind check prior to giving a version tag is to be made
+ *
+ * In summary, a valgrind check prior to giving a version tag is to be made
  * starting from this version to prevent memory leaks.
  *
  *
- * \date 2014-08-29
+ * \date 2015-07-31
  *
  */