diff --git a/.github/labeler.yml b/.github/labeler.yml index d6caa447e2e..464ccdce2b8 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -123,9 +123,7 @@ docs: - '**/*.png' - '**.cff' - CITING - - CHANGES - AUTHORS - - NEWS - TODO - all-globs-to-all-files: - '!doc/development/rfc/**' diff --git a/CHANGES b/CHANGES deleted file mode 100644 index d4c8280bc7b..00000000000 --- a/CHANGES +++ /dev/null @@ -1,10 +0,0 @@ -CHANGES in GRASS GIS 8.x - -https://trac.osgeo.org/grass/wiki/Grass8/NewFeatures80 -https://trac.osgeo.org/grass/wiki/Grass8/NewFeatures82 - -List of releases: - -- GitHub list: https://github.com/OSGeo/grass/releases -- Overview list: https://trac.osgeo.org/grass/wiki/Release -- History: https://grass.osgeo.org/home/history/releases/ (starting 1984!) diff --git a/INSTALL.md b/INSTALL.md index e6bd041fcf9..41249a04143 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -29,8 +29,8 @@ directory. Installation order: 1. PROJ -2. GDAL-OGR (compiled without GRASS support) -3. optionally: databases such as PostgreSQL, MySQL, sqlite +2. GDAL/OGR (compiled without GRASS support) +3. optionally: databases such as PostgreSQL, MySQL, SQLite 4. GRASS GIS 5. optionally: GDAL-OGR-GRASS plugin @@ -41,7 +41,7 @@ GRASS source code is currently distributed in 2 forms: ### Officially released source code The full source code version contains all the GRASS source code -required for compilation. It is distributed as one file (*.tar.gz +required for compilation. It is distributed as one file (`*.tar.gz` package) and the version is composed of 3 numbers, e.g. 3.7.0, 3.7.1 etc. See . @@ -52,7 +52,7 @@ This version of the source code can be acquired either from the GitHub repository () or as a auto-generated snapshot (`*.tar.gz` package) of the GitHub repository. The snapshot name contains the date when the snapshot was created (checked out from -the GitHub repository), e.g. grass-3.7.git_src_snapshot_2022_04_27.tar.gz +the GitHub repository), e.g. `grass-3.7.git_src_snapshot_2022_04_27.tar.gz` from ## (B) COMPILATION @@ -72,7 +72,7 @@ Detailed Wiki notes for various operating systems (MS-Windows, GNU/Linux distributions, FreeBSD, AIX, etc) are available at: -First step of the compilation (-g for debugging, or -O2 for optimization): +First step of the compilation (`-g` for debugging, or `-O2` for optimization): ```bash CFLAGS="-g -Wall" ./configure @@ -108,7 +108,7 @@ make Note for Solaris users (see also Wiki page above): To configure GRASS correctly on a system which doesn't have a suitable -install program (AC_PROG_INSTALL ignores versions which are known to +install program (`AC_PROG_INSTALL` ignores versions which are known to have problems), you need to ensure that $srcdir is an absolute path, by using e.g.: @@ -136,7 +136,7 @@ CC=cc CPP=cpp ./configure ... ## (C) COMPILATION NOTES for 64bit platforms To successfully compile GRASS on 64bit platforms, the required -FFTW2 library has to be compiled with -fPIC flag: +FFTW library has to be compiled with `-fPIC` flag: ```bash #this applies to FFTW3, not to GRASS GIS: @@ -151,13 +151,13 @@ make install After compilation, the resulting code is stored in the directory ```bash -./dist.$ARCH +./dist.$ARCH/ ``` -and the scripts (grass, ...) in +and the script (`grass`) in ```bash -./bin.$ARCH +./bin.$ARCH/ ``` To run GRASS, simply start @@ -175,7 +175,7 @@ grass ## (E) INSTALLATION ON MACOSX -See the ReadMe.rtf in the ./macosx/ folder and the Wiki page above. +See the `ReadMe.rtf` in the `./macosx/` folder and the Wiki page above. ## (F) RUNNING GRASS GIS @@ -206,7 +206,7 @@ make make install ``` -For details, see +For details, see [Guide to contributing on GitHub](./doc/development/github_guide.md). ## (H) COMPILING INDIVIDUAL MODULES - OWN MODULES @@ -240,7 +240,7 @@ gmake Note: If you keep your module source code outside the standard GRASS source code directory structure, you will have to change the relative -path(s) in the Makefile to absolute path(s). +path(s) in the `Makefile` to absolute path(s). ## (I) CODE OPTIMIZATION @@ -258,8 +258,8 @@ setenv CFLAGS -O ./configure ``` -whichever works on your shell. Use -O2 instead of -O if your compiler -supports this (note: O is the letter, not zero). Using the "gcc" compiler, +whichever works on your shell. Use `-O2` instead of `-O` if your compiler +supports this (note: `O` is the letter, not zero). Using the "gcc" compiler, you can also specify processor specific flags (examples, please suggest better settings to us): @@ -272,11 +272,11 @@ CFLAGS="-O2 -msse -msse2 -mfpmath=sse \ CFLAGS="-mtune=nocona -m64 -minline-all-stringops" # Intel Pentium 64bit processor ``` -Note: As of version 4.3.0, GCC offers the -march=native switch that +Note: As of version 4.3.0, GCC offers the `-march=native` switch that enables CPU auto-detection and automatically selects optimizations supported -by the local machine at GCC runtime including -mtune. +by the local machine at GCC runtime including `-mtune`. -To find out optional CFLAGS for your platform, enter: +To find out optional `CFLAGS` for your platform, enter: ```bash gcc -dumpspecs @@ -285,7 +285,7 @@ gcc -dumpspecs See also: A real fast GRASS version (and small binaries) will be created with -LDFLAGS set to "stripping" (but this disables debugging): +`LDFLAGS` set to "stripping" (but this disables debugging): ```bash CFLAGS="-O2 -mcpu= -Wall" LDFLAGS="-s" ./configure @@ -296,7 +296,7 @@ CFLAGS="-O2 -mcpu= -Wall" LDFLAGS="-s" ./configure The `LDFLAGS=""` part must be undefined as `-s` will strip the debugging information. -Don't use `-O` for CFLAGS if you want to be able to step through function +Don't use `-O` for `CFLAGS` if you want to be able to step through function bodies. When optimisation is enabled, the compiler will re-order statements and re-arrange expressions, resulting in object code which barely resembles the source code. @@ -307,7 +307,7 @@ The `-g` and `-Wall` compiler flags are often useful for assisting debugging: CFLAGS="-g -Wall" ./configure ``` -See also the file ./doc/debugging.txt and the Wiki page +See also the file `./doc/debugging.txt` and the Wiki page ## (K) SUPPORT @@ -322,13 +322,15 @@ developers mailing list. See ## (L) GRASS PROGRAMMER'S MANUAL The Programmer's manual is generated with doxygen from the source code. -Please see the README file and the files at: +Please see the [README](doc/development/README.md) file and the files at: ## (M) CONTRIBUTING CODE AND PATCHES -Please see ./SUBMITTING in this directory, or better, - +Please see + +- [GRASS Programming Style Guide](./doc/development/style_guide.md) +- [Guide to contributing on GitHub](./doc/development/github_guide.md) ## Authors diff --git a/Makefile b/Makefile index be8834ecf42..8b32a149a5a 100644 --- a/Makefile +++ b/Makefile @@ -51,7 +51,7 @@ DIRS = \ SUBDIRS = $(DIRS) -FILES = AUTHORS CHANGES CITING COPYING GPL.TXT INSTALL.md REQUIREMENTS.md contributors.csv contributors_extra.csv translators.csv +FILES = AUTHORS CITING COPYING GPL.TXT INSTALL.md REQUIREMENTS.md contributors.csv contributors_extra.csv translators.csv FILES_DST = $(patsubst %,$(ARCH_DISTDIR)/%,$(FILES)) default: diff --git a/NEWS b/NEWS deleted file mode 100644 index 32b4cd52110..00000000000 --- a/NEWS +++ /dev/null @@ -1,18 +0,0 @@ -NEWS - -GRASS GIS 8 - o https://trac.osgeo.org/grass/wiki/Grass8/NewFeatures80 - o https://trac.osgeo.org/grass/wiki/Grass8/NewFeatures82 - -GRASS GIS 7 - o https://trac.osgeo.org/grass/wiki/Grass7/NewFeatures78 - o https://trac.osgeo.org/grass/wiki/Grass7/NewFeatures76 - o https://trac.osgeo.org/grass/wiki/Grass7/NewFeatures74 - o https://trac.osgeo.org/grass/wiki/Grass7/NewFeatures72 - o https://trac.osgeo.org/grass/wiki/Grass7/NewFeatures - - List of releases - o https://trac.osgeo.org/grass/wiki/Release - -GRASS GIS 1-6 - o List of older releases, starting in 1984 (!), see https://grass.osgeo.org/about/history/releases/ diff --git a/README.md b/README.md index b10bd51ec03..7dfdb49df82 100644 --- a/README.md +++ b/README.md @@ -31,11 +31,6 @@ In general: you don't really need write access as you can simply open a [pull request](https://github.com/OSGeo/grass/pulls) to contribute to GRASS GIS. See [CONTRIBUTING file](CONTRIBUTING.md) for more details. -How to get write access here - -Want to become a core developer? See -[Procedure for gaining Git write access](https://trac.osgeo.org/grass/wiki/HowToContribute#WriteaccesstotheGRASScorerepository) - ## How to compile GRASS > See the INSTALL.md file. @@ -111,6 +106,11 @@ this issue, clean all the compiled files from the source code: make distclean ``` +## Further documents + +- [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md) +- [Roadmap](https://grass.osgeo.org/about/roadmap/) + ## Thanks to all contributors ❤ [![GRASS contributors](https://contrib.rocks/image?repo=OSGeo/grass "GRASS contributors")](https://github.com/OSGeo/grass/graphs/contributors) diff --git a/SECURITY.md b/SECURITY.md index feef9649806..0b566dc899d 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -25,7 +25,7 @@ vulnerability, please follow these steps: ## Supported Versions -Please refer to our [Release Schedule](https://trac.osgeo.org/grass/wiki/Release/Schedule) +Please refer to our [download section](https://grass.osgeo.org/download/) for details on which versions are currently supported. ## Security Measures diff --git a/general/g.parser/g.parser.html b/general/g.parser/g.parser.html index 1c0154cca09..b1de89a3a08 100644 --- a/general/g.parser/g.parser.html +++ b/general/g.parser/g.parser.html @@ -673,7 +673,7 @@

SEE ALSO

Overview table: Parser standard options

-Submitting rules for Python +Style Guide: Developing Python scripts

Related Wiki pages: diff --git a/gui/wxpython/gui_core/pyedit.py b/gui/wxpython/gui_core/pyedit.py index 9fa75fa74c1..496e58b6480 100644 --- a/gui/wxpython/gui_core/pyedit.py +++ b/gui/wxpython/gui_core/pyedit.py @@ -634,10 +634,14 @@ def OnModulesHelp(self, event): self.giface.Help("full_index") def OnSubmittingHelp(self, event): - open_url("https://trac.osgeo.org/grass/wiki/Submitting/Python") + open_url( + "https://github.com/OSGeo/grass/blob/main/doc/development/style_guide.md#python" # noqa: E501 + ) def OnAddonsHelp(self, event): - open_url("https://grass.osgeo.org/development/code-submission/") + open_url( + "https://github.com/OSGeo/grass/blob/main/doc/development/style_guide.md#developing-grass-addons" # noqa: E501 + ) def OnSupport(self, event): open_url("https://grass.osgeo.org/support/") diff --git a/rpm/grass.spec b/rpm/grass.spec index a68453145bc..90c79bc939f 100644 --- a/rpm/grass.spec +++ b/rpm/grass.spec @@ -320,7 +320,7 @@ fi %{_docdir}/%{name}%{shortver} %files libs -%license AUTHORS COPYING GPL.TXT CHANGES +%license AUTHORS COPYING GPL.TXT %{_sysconfdir}/ld.so.conf.d/%{name}-%{_arch}.conf %{_libdir}/%{name}%{shortver}/lib/*.so %dir %{_libdir}/%{name}%{shortver}/driver