Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update outdated trac URLs to GitHub #4317

Merged
merged 12 commits into from
Sep 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,7 @@ docs:
- '**/*.png'
- '**.cff'
- CITING
- CHANGES
- AUTHORS
- NEWS
- TODO
- all-globs-to-all-files:
- '!doc/development/rfc/**'
Expand Down
10 changes: 0 additions & 10 deletions CHANGES

This file was deleted.

50 changes: 26 additions & 24 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
<https://github.com/OSGeo/grass/releases>.
Expand All @@ -52,7 +52,7 @@ This version of the source code can be acquired either from the GitHub
repository (<https://github.com/OSGeo/grass/>) 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 <https://grass.osgeo.org/grass-devel/source/snapshot/>

## (B) COMPILATION
Expand All @@ -72,7 +72,7 @@ Detailed Wiki notes for various operating systems (MS-Windows, GNU/Linux
distributions, FreeBSD, AIX, etc) are available at:
<https://grasswiki.osgeo.org/wiki/Compile_and_Install>

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
Expand Down Expand Up @@ -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.:

Expand Down Expand Up @@ -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:
Expand All @@ -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
Expand All @@ -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

Expand Down Expand Up @@ -206,7 +206,7 @@ make
make install
```

For details, see <https://trac.osgeo.org/grass/wiki/HowToGit>
For details, see [Guide to contributing on GitHub](./doc/development/github_guide.md).

## (H) COMPILING INDIVIDUAL MODULES - OWN MODULES

Expand Down Expand Up @@ -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

Expand All @@ -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):

Expand All @@ -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
Expand All @@ -285,7 +285,7 @@ gcc -dumpspecs
See also: <https://gcc.gnu.org/>

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=<cpu_see_above> -Wall" LDFLAGS="-s" ./configure
Expand All @@ -296,7 +296,7 @@ CFLAGS="-O2 -mcpu=<cpu_see_above> -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.
Expand All @@ -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
<https://grasswiki.osgeo.org/wiki/GRASS_Debugging>

## (K) SUPPORT
Expand All @@ -322,13 +322,15 @@ developers mailing list. See <https://grass.osgeo.org/development/>
## (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:
petrasovaa marked this conversation as resolved.
Show resolved Hide resolved
<https://grass.osgeo.org/programming8/>

## (M) CONTRIBUTING CODE AND PATCHES

Please see ./SUBMITTING in this directory, or better,
<https://trac.osgeo.org/grass/wiki/Submitting>
Please see

- [GRASS Programming Style Guide](./doc/development/style_guide.md)
- [Guide to contributing on GitHub](./doc/development/github_guide.md)

## Authors

Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
18 changes: 0 additions & 18 deletions NEWS

This file was deleted.

10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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)
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion general/g.parser/g.parser.html
Original file line number Diff line number Diff line change
Expand Up @@ -673,7 +673,7 @@ <h2>SEE ALSO</h2>
<p>
Overview table: <a href="parser_standard_options.html">Parser standard options</a>
<p>
<a href="http://trac.osgeo.org/grass/wiki/Submitting/Python">Submitting rules for Python</a>
<a href="https://github.com/OSGeo/grass/blob/main/doc/development/style_guide.md#developing-python-scripts">Style Guide: Developing Python scripts</a>

<p>
Related Wiki pages:
Expand Down
8 changes: 6 additions & 2 deletions gui/wxpython/gui_core/pyedit.py
Original file line number Diff line number Diff line change
Expand Up @@ -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/")
Expand Down
2 changes: 1 addition & 1 deletion rpm/grass.spec
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading