|
1 | 1 | # Changelog |
2 | 2 |
|
| 3 | +## 2025-02-10 - Documentation Overhaul and Process Improvements |
| 4 | + |
| 5 | +### Documentation Structure and Organization |
| 6 | +- Established standardized documentation format across all components |
| 7 | +- Enhanced core library documentation with detailed API references |
| 8 | +- Improved cross-referencing between related documentation files |
| 9 | +- Added comprehensive examples and use cases for all major features |
| 10 | + |
| 11 | +### Process Improvements |
| 12 | +- Implemented new periodic review process with clear guidelines |
| 13 | +- Added structured approach for tracking and documenting changes |
| 14 | +- Enhanced changelog management with better categorization |
| 15 | +- Improved worklog organization for technical details |
| 16 | + |
| 17 | +### Tool Documentation |
| 18 | +- Enhanced documentation for all Python and shell tools: |
| 19 | + - `chunkfile.py`: Complete rewrite with detailed API docs |
| 20 | + - `warehouse.sh`: Added comprehensive usage guide |
| 21 | + - `generate_manifest.sh`: Enhanced with git integration details |
| 22 | +- Added visual guides for complex operations |
| 23 | +- Updated all command-line help messages |
| 24 | + |
| 25 | +### Technical Documentation |
| 26 | +- Added detailed architecture documentation |
| 27 | +- Enhanced troubleshooting guides |
| 28 | +- Improved installation and setup instructions |
| 29 | +- Added performance considerations and best practices |
| 30 | + |
| 31 | +## 2025-02-06 - Major Release: Library Reorganization and New Tools |
| 32 | + |
| 33 | +### Core Library Reorganization |
| 34 | +- Renamed all shell library files to use `_lib.sh` suffix for better organization |
| 35 | +- Added new core libraries and new functionality: |
| 36 | + - `config_lib.sh`: Configuration management functions |
| 37 | + - `type_lib.sh`: Type checking and validation |
| 38 | + - `string_lib.sh`: String manipulation utilities |
| 39 | + - `errno_lib.sh`: Enhanced error handling |
| 40 | + - `helpsys_lib.sh`: Improved help system |
| 41 | + - `init_lib.sh`: Initialization routines |
| 42 | + - `venvutil_lib.sh`: Virtual environment utilities |
| 43 | + - `wrapper_lib.sh`: Command wrapping functions |
| 44 | + |
| 45 | +### Virtual Environment Enhancements |
| 46 | +- Enhanced `lenv` function with new capabilities: |
| 47 | + - Added column headers for better readability |
| 48 | + - Added Python version display for each environment |
| 49 | + - Improved sorting by time or name (forward/reverse) |
| 50 | + - Enhanced long format time display with date and time |
| 51 | + - Added environment status indicators |
| 52 | +- Improved `ccln` (clone) function: |
| 53 | + - Added support for cloning without sequence number |
| 54 | + - Enhanced error handling during clone operations |
| 55 | + - Added automatic environment activation after cloning |
| 56 | +- Added virtual environment renaming capability: |
| 57 | + - New `renv` function for renaming environments |
| 58 | + - Preserves all packages and configurations |
| 59 | + - Handles both sequenced and non-sequenced environments |
| 60 | + - Updates environment references in configuration |
| 61 | + - Maintains environment history and logs |
| 62 | +- Added new environment management features: |
| 63 | + - Better environment variable handling |
| 64 | + - Improved error recovery mechanisms |
| 65 | + - Enhanced logging for all venv operations |
| 66 | + |
| 67 | +### New Tools and Utilities |
| 68 | +- Added performance testing tools: |
| 69 | + - `torch_torture.py`: PyTorch stress testing |
| 70 | + - `numpy_torture.py`: NumPy stress testing |
| 71 | + - `numpy-comp` and `numpy-comp.sh`: NumPy compilation tools |
| 72 | + - `compare_test`: General performance comparison framework |
| 73 | +- Added chat management utilities: |
| 74 | + - `extract-chat` and `extract_chat.py`: Chat extraction tools |
| 75 | + - `rename-chat` and `rename-chat.py`: Chat renaming utilities |
| 76 | + |
| 77 | +### Core System Improvements |
| 78 | +- Enhanced `setup.sh` with improved Conda integration and error handling |
| 79 | +- Updated `setup.cf` with new configuration options |
| 80 | +- Modified core utilities for better performance: |
| 81 | + - `purgevenv`: Enhanced cleanup operations |
| 82 | + - `genmd`: Better documentation generation |
| 83 | +- Enhanced `requirements.txt` with latest dependencies |
| 84 | + |
| 85 | +### Documentation Enhancements |
| 86 | +- Added new documentation: |
| 87 | + - `Metrics_Layout.md`: Performance metrics documentation |
| 88 | +- Updated existing documentation: |
| 89 | + - `Standards.md`: Updated coding standards |
| 90 | + - `filetree.md`: New file structure documentation |
| 91 | + - `installer-manifest.md`: Updated installation guide |
| 92 | +- Comprehensive updates to function documentation in `docs/shdoc/` |
| 93 | + |
| 94 | +### Technical Improvements |
| 95 | +- Enhanced error handling across all utilities: |
| 96 | + - Better POSIX errno code handling |
| 97 | + - Improved error message formatting |
| 98 | + - Enhanced error context for debugging |
| 99 | +- Improved virtual environment management: |
| 100 | + - Better state tracking |
| 101 | + - Enhanced environment switching |
| 102 | + - Improved environment cleanup |
| 103 | +- Better type checking and validation: |
| 104 | + - Added robust type checking functions |
| 105 | + - Enhanced input validation |
| 106 | + - Improved error reporting |
| 107 | +- Enhanced string manipulation functions: |
| 108 | + - Added new string cleaning utilities |
| 109 | + - Improved pattern matching |
| 110 | + - Better text formatting |
| 111 | +- Improved configuration management: |
| 112 | + - Enhanced config file handling |
| 113 | + - Better default value management |
| 114 | + - Improved configuration validation |
| 115 | +- Better help system organization: |
| 116 | + - Enhanced function documentation |
| 117 | + - Improved command-line help |
| 118 | + - Better cross-referencing |
| 119 | + |
| 120 | +## 2025-01-09 - Script Sourcing and Directory Handling Improvements |
| 121 | + |
| 122 | +### Shell Include Files Enhancements |
| 123 | + |
| 124 | +- Implemented consistent script sourcing tracking across all function include scripts |
| 125 | +- Fixed bug in script sourcing prevention mechanism |
| 126 | +- Improved directory creation handling |
| 127 | +- Streamlined directory operations with optimized `mkdir -p` usage |
| 128 | + |
| 129 | +### Core Script Updates |
| 130 | + |
| 131 | +- `init_env.sh`: Enhanced script sourcing control with improved tracking |
| 132 | +- `help_sys.sh`: Improved directory handling and path management |
| 133 | +- `errno.sh`: Cleaned up code organization and removed redundant sections |
| 134 | +- `util_funcs.sh`: Enhanced directory operations and error handling |
| 135 | +- `venv_funcs.sh`: Updated script sourcing mechanism for better reliability |
| 136 | +- `wrapper_funcs.sh`: Improved function loading control and consistency |
| 137 | +- `buildvenvs`: Updated directory handling for better efficiency (experimental) |
| 138 | +- `modules/conda-install.sh`: Enhanced installation process and error handling (experimental) |
| 139 | + |
| 140 | +### Technical Improvements |
| 141 | + |
| 142 | +- Removed redundant directory existence checks before mkdir operations |
| 143 | +- Standardized script sourcing prevention across all include files |
| 144 | +- Enhanced error handling for directory operations |
| 145 | +- Improved code organization and cleanup |
| 146 | + |
3 | 147 | ## 2024-12-30 - Help System and Documentation Enhancements |
4 | 148 |
|
5 | 149 | ### Help System Improvements |
@@ -357,5 +501,3 @@ This collection includes build scripts, benchmarking tools, and regression testi |
357 | 501 | If you find any of my work here helpful, please reach out. I would like to have a dialog with anyone else interested. |
358 | 502 |
|
359 | 503 | Watch this spot, more to come, and you can always [buy me a coffee.](https://www.buymeacoffee.com/venvutil) |
360 | | - |
361 | | -# |
|
0 commit comments