blob: 9aef54e8a743cb2748bd1194fd32a5128a2d0f58 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
---
title: Deprecation
description: The Hugo project follows a formal and consistent process to deprecate functions, methods, and configuration settings.
categories: [troubleshooting]
keywords: []
menu:
docs:
parent: troubleshooting
weight: 50
weight: 50
---
When a project _deprecates_ something, they are telling its users:
1. Don't use Thing One anymore.
2. Use Thing Two instead.
3. We're going to remove Thing One at some point in the future.
[article]: https://en.wikipedia.org/wiki/Deprecation
Think of deprecation as a statement of intent. This Wikipedia [article] describes common reasons for deprecation:
- The feature has been replaced by a more powerful alternative.
- The feature contains a design flaw.
- The feature is considered extraneous, and will be removed in the future in order to simplify the system as a whole.
- A future version of the software will make major structural changes, making it impossible or impractical to support older features.
- Standardization or increased consistency in naming.
- A feature that once was available only independently is now combined with its co-feature.
After the project team deprecates something in code, Hugo will:
1. Log an INFO message for 6 minor releases[^1]
2. Log a WARN message for another 6 minor releases
3. Log an ERROR message and fail the build thereafter
To see the INFO messages, you must use the `--logLevel` command line flag:
```text
hugo --logLevel info
```
To limit the output to deprecation notices:
```text
hugo --logLevel info | grep deprecate
```
Run the above command every time you upgrade Hugo.
[^1]: For example, v0.1.1 => v0.2.0 is a minor release.
|
